Sign in
knowledgeStoreItems

List knowledge store items

This method returns a list of items in the specified knowledge store.

get/knowledge-stores/{knowledge_store_id}/items

Path parameters

knowledge_store_idstring required

The unique identifier of the knowledge store.

Query parameters

pageinteger

A number that identifies the page to retrieve.

Default: 1.

page_limitinteger

The number of items to return on each page.

Default: 10. Max: 50.

sort_by'created_at' | 'updated_at'

The field to sort on. The following options are available:

  • created_at: Sorts by the time, in the RFC 3339 format ("YYYY-MM-DDTHH:mm:ssZ"), when the item was created.
  • updated_at: Sorts by the time, in the RFC 3339 format ("YYYY-MM-DDTHH:mm:ssZ"), when the item was last updated.

Default: created_at.

sort_optionstring

The sorting direction. The following options are available:

  • asc
  • desc

Default: desc.

statusKnowledgeStoresKnowledgeStoreIdItemsGetParametersStatusSchemaItems[]

Filter by one or more item processing statuses. For the meaning of each value, see the Item statuses section on The knowledge store item object page.

To filter by multiple statuses, repeat the status parameter for each value:

status=queued&status=pending

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 items have been successfully retrieved.

Changes

Changed in 2 of the 8 revisions of this API.11