Agents (Research preview)Knowledge store itemsItem collections

Add items to an 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.

Authentication

x-api-keystring
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>

Path parameters

knowledge_store_idstringRequired
The unique identifier of the knowledge store.
collection_idstringRequired
The unique identifier of the knowledge store item collection.

Request

This endpoint expects an object.
item_idslist of stringsRequired
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.
metadatamap from strings to strings
Custom metadata for the item collection.
member_countintegerRead-only
The number of items in the collection.
created_atstringformat: "date-time"
The date and time when the item collection was created, in the RFC 3339 format.
updated_atstringformat: "date-time"
The date and time when the item collection was last updated, in the RFC 3339 format.

Errors

400
Bad Request Error