Sign in

v3

latestOpenAPI 3.1.02026-07-3197486526.1 KB
knowledgeStoreItems

Retrieve a knowledge store item

This method retrieves the details of a specific knowledge store item.

get/knowledge-stores/{knowledge_store_id}/items/{item_id}

Path parameters

knowledge_store_idstring required

The unique identifier of the knowledge store.

item_idstring required

The unique identifier of the knowledge store item.

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>

Response

The knowledge store item has been successfully retrieved.

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