knowledgeStores

Create a knowledge store

Changed on

This method creates a knowledge store.

Provide a name. Optionally include a description, a metadata map, and an ingestion_config object that controls how content added to the store is processed. The ingestion_config object is immutable after creation.

post/knowledge-stores

Request

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

Request body

namestring required

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.

Response

The knowledge store has been successfully created.

_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