Update 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 updates the specified knowledge store. Only the name, description, and metadata fields can be updated.

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.

Request

This endpoint expects an object.

namestringOptional

The name of the knowledge store.

descriptionstringOptional

An optional description of the knowledge store.

metadatamap from strings to strings or integers or doubles or booleans or lists of stringsOptional

Custom metadata for the knowledge store, as user-defined key-value pairs. Up to 10 pairs, keys up to 128 characters, string values up to 2048 characters. Keys are strings; values can be a string, a number, a boolean, or an array of strings. A nested object, an array containing anything other than strings, and a null value are rejected. An integer must fit in 53 bits (-9007199254740991 to 9007199254740991). Send a wider integer, or an identifier that must be preserved verbatim, as a string. The provided object replaces the existing metadata in full, so include every key you want to keep and omit the ones you want to remove. To clear all metadata, set this field to an empty object ({}).

Response

The knowledge store has been successfully updated.

_idstringOptional

The unique identifier of the knowledge store.

namestringOptional

The name of the knowledge store.

descriptionstringOptional

An optional description of the knowledge store.

ingestion_configobjectOptional

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

item_countintegerOptionalRead-only

The number of items in the knowledge store.

created_atstringOptionalformat: "date-time"

The date and time when the knowledge store was created, in the RFC 3339 format.

updated_atstringOptionalformat: "date-time"

The date and time when the knowledge store was last updated, in the RFC 3339 format.

metadatamap from strings to strings or integers or doubles or booleans or lists of stringsOptional

Custom metadata for the knowledge store. Keys are strings; each value is a string, a number, a boolean, or an array of strings.

Errors

400

Bad Request Error