Sign in

v3

latestOpenAPI 3.1.02026-07-3197486526.1 KB
knowledgeStores

Update a knowledge store

This method updates the specified knowledge store. Only the name, description, and metadata fields can be updated.

patch/knowledge-stores/{knowledge_store_id}

Path parameters

knowledge_store_idstring required

The unique identifier of the knowledge store.

Headers

x-api-keystring required

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>

Request body

namestring

The name of the knowledge store.

descriptionstring

An optional description of the knowledge store.

metadataobject

Custom metadata for the knowledge store. Both keys and values must be strings. The provided object replaces the existing metadata in full, so include every key you want to keep. To clear all metadata, set this field to an empty object ({}). A null value is stored as an empty string.

Response

The knowledge store has been successfully updated.

_idstring

The unique identifier of the knowledge store.

namestring

The name of the knowledge store.

descriptionstring

An optional description of the knowledge store.

item_countinteger

The number of items in the knowledge store.

created_atstring date-time

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

updated_atstring date-time

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

metadataobject

Custom metadata for the knowledge store.