Sign in

v3

latestOpenAPI 3.1.02026-07-3197486526.1 KB
knowledgeStoreItems

Create a knowledge store item

This method adds an asset to a knowledge store for processing. The operation is asynchronous. The item is created immediately with the queued status and processed in the background.

The asset must not exceed 5 GB.

post/knowledge-stores/{knowledge_store_id}/items

Path parameters

knowledge_store_idstring required

The unique identifier of the knowledge store.

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

asset_type'video' | 'image'

The type of item in the knowledge store.

asset_idstring required

The unique identifier of the asset to add to the knowledge store.

metadataobject

Custom metadata for the item. Both keys and values must be strings.

Response

The item creation request has been accepted and is processing.

_idstring

The unique identifier of the knowledge store item.

asset_type'video' | 'image' required

The type of item in the knowledge store.

asset_idstring

The unique identifier of the source asset.

status'queued' | 'pending' | 'processing' | 'ready' | 'failed'

The processing status of the item. For the meaning of each value, see the Item statuses section on The knowledge store item object page.

metadataobject

Custom metadata for the item.

created_atstring date-time

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

updated_atstring date-time

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