knowledgeStoreItemCollections

Update a knowledge store item collection

Changed on

Updates the name, description, and metadata fields of the specified item collection.

patch/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.

Request body

namestring

The name of the item collection. Must be unique within the knowledge store.

descriptionstring

An optional description of the item collection.

metadataobject

Custom metadata for the item collection, as user-defined key-value pairs. Up to 10 pairs, keys up to 128 characters, string values up to 2048 characters. Keys are strings; values can be a string, a number, a boolean, or an array of strings. A nested object, an array containing anything other than strings, and a null value are rejected. An integer must fit in 53 bits (-9007199254740991 to 9007199254740991). Send a wider integer, or an identifier that must be preserved verbatim, as a string. The provided object replaces the existing metadata in full, so include every key you want to keep and omit the ones you want to remove. To clear all metadata, set this field to an empty object ({}).

Response

The item collection has been successfully updated.

_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