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>" \
     -d sort_by=created_at

{
  "data": [
    {
      "_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": {}
    }
  ],
  "page_info": {
    "limit_per_page": 10,
    "page": 1,
    "total_page": 1,
    "total_results": 2
  }
}

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.

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.

Allowed values:

sort_optionstringOptionalDefaults to desc

The sorting direction. The following options are available:

asc
desc

Default: desc.

Response

The knowledge stores have been successfully retrieved.

datalist of objectsOptional

An array containing the knowledge stores.

page_infoobjectOptional

An object that provides information about pagination.

Errors

400

Bad Request Error