knowledgeStoreItemCollections

List knowledge store item collections

Changed on

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

get/knowledge-stores/{knowledge_store_id}/item-collections

Request

  • Base URL: https://api.twelvelabs.io/v1.3
  • URL: https://api.twelvelabs.io/v1.3/knowledge-stores/{knowledge_store_id}/item-collections
  • Auth: API key in header x-api-key

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' | 'name'

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.

sort_optionstring

The sorting direction. The following options are available:

  • asc
  • desc

Default: desc.

Response

The item collections have been successfully retrieved.

Changes

  • b8591e05c0baRevision changes
    • warning

      deleted the header request parameter x-api-key

    • info

      the endpoint scheme security x-api-key was added to the API

  • 6205c7327cdeRevision changes
    • info

      api operation id list removed and replaced with knowledgeStoreItemCollections_list