Sign in

v3

latestOpenAPI 3.1.02026-07-3197486526.1 KB
knowledgeStoreItemCollections

Add items to a knowledge store item collection

Adds one or more items to the specified item collection. This operation is idempotent — items already in the collection are skipped. Every identifier must reference an existing item in the knowledge store.

post/knowledge-stores/{knowledge_store_id}/item-collections/{collection_id}/items/add

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

item_idsstring[] required

The unique identifiers of the items to add to the collection. Include up to 500 identifiers per request.

Response

The items have been successfully added to the collection.

_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.