Retrieve a knowledge store

GET

https://api.twelvelabs.io/v1.3/knowledge-stores/:knowledge_store_id

GET

/v1.3/knowledge-stores/:knowledge_store_id

$ curl https://api.twelvelabs.io/v1.3/knowledge-stores/ks_069e9869-1ea3-7481-8000-dae72bf6be6e \
>      -H "x-api-key: <apiKey>"

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       "type": "json_schema",
8       "json_schema": {
9         "type": "object",
10         "properties": {
11           "topic": {
12             "type": "string",
13             "description": "The main topic discussed in this shot"
14           },
15           "sentiment": {
16             "type": "string",
17             "enum": [
18               "positive",
19               "negative",
20               "neutral"
21             ],
22             "description": "The overall sentiment of the shot"
23           }
24         },
25         "required": [
26           "topic"
27         ]
28       }
29     }
30   },
31   "item_count": 5,
32   "created_at": "2024-01-15T09:30:00Z",
33   "updated_at": "2024-01-15T09:30:00Z",
34   "metadata": {}
35 }

This method retrieves the details of a specific knowledge store.

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>

Path parameters

knowledge_store_idstringRequired

The unique identifier of the knowledge store.

Response

The knowledge store has been successfully retrieved.

_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