knowledgeStoreItemCollections

Retrieve a knowledge store item collection

Changed on

Retrieves the details of a specific item collection.

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

Request

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

Path parameters

knowledge_store_idstring required

The unique identifier of the knowledge store.

collection_idstring required

The unique identifier of the knowledge store item collection.

Response

The item collection has been successfully retrieved.

_idstring

The unique identifier of the item collection.

knowledge_store_idstring

The unique identifier of the knowledge store this collection belongs to.

namestring

The name of the item collection.

descriptionstring

The description of the item collection.

metadataobject

Custom metadata for the item collection. Keys are strings; each value is a string, a number, a boolean, or an array of strings.

member_countinteger

The number of items in the collection.

created_atstring date-time

The date and time when the item collection was created, in the RFC 3339 format.

updated_atstring date-time

The date and time when the item collection was last updated, in the RFC 3339 format.

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 retrieve removed and replaced with knowledgeStoreItemCollections_retrieve