Sign in

v3

latestOpenAPI 3.1.02026-07-3197486526.1 KB
knowledgeStoreItemCollections

Update a knowledge store item collection

Updates the name, description, and metadata fields of the specified item collection.

patch/knowledge-stores/{knowledge_store_id}/item-collections/{collection_id}

Path parameters

knowledge_store_idstring required

The unique identifier of the knowledge store.

collection_idstring required

The unique identifier of the knowledge store item collection.

Headers

x-api-keystring required

Your API key.

<Note title="Note"> You can find your API key on the <a href="https://playground.twelvelabs.io/dashboard/api-keys" target="_blank">API Keys</a> page. </Note>

Request body

namestring

The name of the item collection. Must be unique within the knowledge store.

descriptionstring

An optional description of the item collection.

metadataobject

Custom metadata for the item collection. Both keys and values must be strings. To remove all metadata, set this field to an empty object ({}).

Response

The item collection has been successfully updated.

_idstring

The unique identifier of the item collection.

knowledge_store_idstring

The unique identifier of the knowledge store this collection belongs to.

namestring

The name of the item collection.

descriptionstring

The description of the item collection.

metadataobject

Custom metadata for the item collection.

member_countinteger

The number of items in the collection.

created_atstring date-time

The date and time when the item collection was created, in the RFC 3339 format.

updated_atstring date-time

The date and time when the item collection was last updated, in the RFC 3339 format.