Skip to navigation
Agents (Research preview)Knowledge store itemsItem collections

List item collections

Returns a list of the item collections in the specified knowledge store.

Authentication

x-api-keystring

Your API key.

Note

You can find your API key on the API Keys page.

Path parameters

knowledge_store_idstringRequired
The unique identifier of the knowledge store.

Query parameters

pageintegerOptionalDefaults to 1

A number that identifies the page to retrieve.

Default: 1.

page_limitintegerOptionalDefaults to 10

The number of items to return on each page.

Default: 10. Max: 50.

sort_byenumOptionalDefaults to created_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 collection was created.
  • updated_at: Sorts by the time, in the RFC 3339 format ("YYYY-MM-DDTHH:mm:ssZ"), when the item collection was last updated.
  • name: Sorts alphabetically by the name of the item collection.

Default: created_at.

Allowed values:
sort_optionstringOptionalDefaults to desc

The sorting direction. The following options are available:

  • asc
  • desc

Default: desc.

Response

The item collections have been successfully retrieved.
datalist of objectsOptional
An array containing the item collections.
page_infoobjectOptional
An object that provides information about pagination.

Errors

400
Bad Request Error