Skip to main content
Update Kb
A PATCH applies only the fields you send. Anything you omit keeps its current value, so send just what is changing:
Sending a full object you read earlier is the common mistake: any field whose value you did not intend to change is still written. kb_type in particular changes how the agent retrieves from this knowledge base, so include it only when you mean to change it.
The allowed values are the same as on create: language is english or multilingual, and kb_type is deterministic or non_deterministic. Documents are not affected - editing the knowledge base does not re-run ingestion.

Authorizations

Authorization
string
header
required

Your API key as a Bearer token, e.g. Authorization: Bearer vk_….

Path Parameters

kb_id
string
required

The knowledge base's id, from POST/GET /v1/knowledge-bases.

Body

application/json
name
string | null

What to call this knowledge base.

Required string length: 1 - 255
description
string | null

Your own note about what is in it.

language
string | null

english or multilingual, matching the content you will upload.

Pattern: ^(english|multilingual)$
kb_type
string | null

non_deterministic composes an answer from matching passages; deterministic answers only on a near-exact match and returns the stored text verbatim — which suits pricing, policy and legal copy that must not be paraphrased.

Pattern: ^(deterministic|non_deterministic)$

Response

The updated knowledge base.

One knowledge base.

language and kb_type are both growing enums — match on the values you know and fall through on the rest, rather than switching exhaustively.

documents is returned by get-by-id and is null in the list, the same convention as transcript on a call.

id
string
required

The knowledge base's id. List it in an agent's knowledge_base_ids to attach it.

name
string
required

What it is called.

description
string | null
required

Your own note about what is in it.

language
string
required

The language its content is in.

kb_type
string
required

How answers are produced: non_deterministic composes an answer from matching passages, deterministic answers only on a near-exact match and returns the stored text verbatim — which suits pricing, policy and legal copy that must not be paraphrased.

document_count
integer
required

How many documents it holds.

created_at
string<date-time>
required

When it was created (UTC, ISO 8601).

updated_at
string<date-time>
required

When it last changed (UTC, ISO 8601).

documents
PublicKnowledgeBaseDocumentRead · object[] | null

The documents themselves, with their ingestion status.