Skip to main content
Get Kb

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.

Response

The knowledge base, including its documents.

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.