List knowledge stores

{
  "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": {
              "brand": {
                "type": "string",
                "description": "The brand featured in the video",
                "granularity": "video"
              },
              "topic": {
                "type": "string",
                "description": "The main topic discussed in this shot",
                "granularity": "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.

asset_idstringOptional

Filter by the unique identifier of an asset. A knowledge store matches when it contains an item that uses the asset. The item can have any status.

If the identifier is valid but belongs to no asset, the platform returns a 200 response with an empty data array. It does not return an error. If you send an empty value or a value that is not a valid asset identifier, the platform returns a 400 error with the parameter_invalid code. It returns the same error if you repeat the parameter.

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