v3

latestOpenAPI 3.1.02026-07-3197486526.1 KB
knowledgeStores

Create a knowledge store

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

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>

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. Both keys and values must be strings.

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.