List knowledge stores

GET

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

GET

/v1.3/knowledge-stores

$ curl -G https://api.twelvelabs.io/v1.3/knowledge-stores \
>      -H "x-api-key: <apiKey>" \
>      -H "Content-Type: application/json" \
>      -d sort_by=created_at

1 {
2   "data": [
3     {
4       "_id": "ks_069e9869-1ea3-7481-8000-dae72bf6be6e",
5       "name": "Product Demo Analysis",
6       "description": "Knowledge store for product demo videos",
7       "ingestion_config": {
8         "enrichment_config": {
9           "type": "json_schema",
10           "json_schema": {
11             "type": "object",
12             "properties": {
13               "topic": {
14                 "type": "string",
15                 "description": "The main topic discussed in this shot"
16               },
17               "sentiment": {
18                 "type": "string",
19                 "enum": [
20                   "positive",
21                   "negative",
22                   "neutral"
23                 ],
24                 "description": "The overall sentiment of the shot"
25               }
26             },
27             "required": [
28               "topic"
29             ]
30           }
31         }
32       },
33       "item_count": 5,
34       "created_at": "2024-01-15T09:30:00Z",
35       "updated_at": "2024-02-20T14:45:00Z",
36       "metadata": {
37         "department": "Marketing",
38         "project": "Q1 Product Launch"
39       }
40     },
41     {
42       "_id": "ks_0a7b3c4d-2f56-4e89-9001-123456789abc",
43       "name": "Customer Support Training",
44       "description": "Knowledge store for customer support training videos",
45       "ingestion_config": {
46         "enrichment_config": {
47           "type": "description",
48           "description": "Extract key customer issues, resolution steps, and agent performance metrics"
49         }
50       },
51       "item_count": 12,
52       "created_at": "2023-11-10T11:00:00Z",
53       "updated_at": "2024-03-05T16:20:00Z",
54       "metadata": {
55         "department": "Support",
56         "region": "EMEA"
57       }
58     }
59   ],
60   "page_info": {
61     "limit_per_page": 10,
62     "page": 1,
63     "total_page": 1,
64     "total_results": 2
65   }
66 }

This method returns a list of the knowledge stores in your account.

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>

Query parameters

pageintegerOptionalDefaults to 1

A number that identifies the page to retrieve.

Default: 1.

page_limitintegerOptionalDefaults to 10

The number of items to return on each page.

Default: 10. Max: 50.

sort_byenumOptionalDefaults to created_at

The field to sort on. The following options are available:

created_at: Sorts by the time, in the RFC 3339 format (“YYYY-MM-DDTHH:mm:ssZ”), when the knowledge store was created.
updated_at: Sorts by the time, in the RFC 3339 format (“YYYY-MM-DDTHH:mm:ssZ”), when the knowledge store was updated.

Default: created_at.

The field to sort on. The following options are available: - `created_at`: Sorts by the time, in the RFC 3339 format ("YYYY-MM-DDTHH:mm:ssZ"), when the knowledge store was created. - `updated_at`: Sorts by the time, in the RFC 3339 format ("YYYY-MM-DDTHH:mm:ssZ"), when the knowledge store was updated. **Default**: `created_at`.

Allowed values:

sort_optionstringOptionalDefaults to desc

The sorting direction. The following options are available:

asc
desc

Default: desc.

The sorting direction. The following options are available: - `asc` - `desc` **Default**: `desc`.

Response

The knowledge stores have been successfully retrieved.

datalist of objects

An array containing the knowledge stores.

page_infoobject

An object that provides information about pagination.

Errors

400

Bad Request Error