Sign in
knowledgeStoreItemCollections

List knowledge store item collections

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

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

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.

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

Changes

Changed in 3 of the 11 revisions of this API.111

  • 335e364dd9b51See the full diff
    • ▲

      response property data/items/metadata/additionalProperties/ list-of-types was widened by adding types array boolean integer and number to media type application/json of response 200

      response-property-list-of-types-widened

  • 5dbd6e8473c91See the full diff
    • ●

      removed the optional property docs_url from the response with the 400 status

      response-optional-property-removed

  • c0926990c6621See the full diff
    • ○

      endpoint added

      endpoint-added

    This revision also has 35 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog