knowledgeStores

Update a knowledge store

Changed on

This method updates the specified knowledge store. Only the name, description, and metadata fields can be updated.

patch/knowledge-stores/{knowledge_store_id}

Request

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

Path parameters

knowledge_store_idstring required

The unique identifier of the knowledge store.

Request body

namestring

The name of the knowledge store.

descriptionstring

An optional description of the knowledge store.

metadataobject

Custom metadata for the knowledge store, 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 knowledge store has been successfully updated.

_idstring

The unique identifier of the knowledge store.

namestring

The name of the knowledge store.

descriptionstring

An optional description of the knowledge store.

item_countinteger

The number of items in the knowledge store.

created_atstring date-time

The date and time when the knowledge store was created, in the RFC 3339 format.

updated_atstring date-time

The date and time when the knowledge store was last updated, in the RFC 3339 format.

metadataobject

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

Changes