Create a knowledge store

{
  "_id": "ks_069e9869-1ea3-7481-8000-dae72bf6be6e",
  "name": "Product Demo Analysis",
  "description": "Knowledge store for product demo videos",
  "ingestion_config": {
    "enrichment_config": {
      "type": "json_schema",
      "json_schema": {
        "type": "object",
        "properties": {
          "topic": {
            "type": "string",
            "description": "The main topic discussed in this shot"
          },
          "sentiment": {
            "type": "string",
            "enum": [
              "positive",
              "negative",
              "neutral"
            ],
            "description": "The overall sentiment of the shot"
          }
        },
        "required": [
          "topic"
        ]
      }
    }
  },
  "item_count": 5,
  "created_at": "2024-01-15T09:30:00Z",
  "updated_at": "2024-01-15T09:30:00Z",
  "metadata": {}
}

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.

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 the knowledge store is processed.

descriptionstringOptional

An optional description of the knowledge store.

metadatamap from strings to stringsOptional

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.

ingestion_configobject

The ingestion configuration set when this knowledge store was created. Immutable.

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

Custom metadata for the knowledge store.

Errors

400

Bad Request Error

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