Create a knowledge store

Creates a new knowledge store. A knowledge store holds your videos plus the understanding the platform derives from them: spatiotemporal context, a typed ontology, and embeddings for semantic retrieval. Agents use knowledge stores to reason across the full video collection, not just individual clips.

Authentication

x-api-keystring

Your API key.

Note

You can find your API key on the API Keys page.

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

This endpoint expects an object.

namestringRequired

The name of the knowledge store.

ingestion_configobjectOptional

Configuration that controls how content added to this knowledge store is processed. This field is immutable after creation.

descriptionstringOptional

An optional description of the knowledge store.

metadatamap from strings to stringsOptional

Key-value pairs to attach to the knowledge store.

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.

ingestion_configobject

Configuration that controls how content added to this knowledge store is processed. This field is immutable after creation.

item_countintegerRead-only

The number of items in the knowledge store.

created_atstringformat: "date-time"

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

updated_atstringformat: "date-time"

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

metadatamap from strings to strings

Key-value pairs attached to the knowledge store.

Errors

400

Bad Request Error

1	curl -X POST https://api.twelvelabs.io/v1.3/knowledge-stores \
2	-H "x-api-key: <apiKey>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"name": "Product Demo Analysis"
6	}'

1	{
2	"_id": "ks_069e9869-1ea3-7481-8000-dae72bf6be6e",
3	"name": "Product Demo Analysis",
4	"description": "Knowledge store for product demo videos",
5	"ingestion_config": {
6	"enrichment_config": {
7	"json_schema": {
8	"type": "object",
9	"properties": {
10	"topic": {
11	"type": "string",
12	"description": "The main topic discussed in this shot"
13	},
14	"sentiment": {
15	"type": "string",
16	"enum": [
17	"positive",
18	"negative",
19	"neutral"
20	]
21	}
22	}
23	}
24	}
25	},
26	"item_count": 5,
27	"created_at": "2024-01-15T09:30:00Z",
28	"updated_at": "2024-01-15T09:30:00Z",
29	"metadata": {}
30	}