Read a Knowledge base version
GET /v1/knowledge-bases/{knowledge_base_id}/versions/{version}
Property Value Operation get_knowledge_base_versionGroup Knowledge bases Scope knowledge:readRoute class readIdempotency No Idempotency-Key Audit Not audited: A configuration read; a Knowledge base and its versions carry no content. Released in 1.53.0 Phase 0 host Served (the hosted api pins 1.65.0)
Request
Set VOCAL_API to the base URL of your API and VOCAL_API_KEY to an API key with the knowledge:read scope (Authentication and keys ). Replace each placeholder, such as agt_... or <name>, with your own value.
cURL Node.js Python
curl "$VOCAL_API/v1/knowledge-bases/kb_.../versions/1" \
-H "Authorization: Bearer $VOCAL_API_KEY"const response = await fetch(`${process.env.VOCAL_API}/v1/knowledge-bases/kb_.../versions/1`, {
headers: {
Authorization: `Bearer ${process.env.VOCAL_API_KEY}`,
},
});
console.log(response.status, await response.text());import os
import requests
response = requests.get(
f"{os.environ['VOCAL_API']}/v1/knowledge-bases/kb_.../versions/1",
headers={
"Authorization": f"Bearer {os.environ['VOCAL_API_KEY']}",
},
)
print(response.status_code, response.text)Parameters
Name In Type Required Description knowledge_base_idpath KnowledgeBaseId yes The id of a Knowledge base: kb_ and the row's UUIDv7 in 26 Crockford base32 characters. Opaque and safe to log. versionpath integer yes A version number, from 1.
Responses
Fields of the 200 answer
The shape is KnowledgeBaseVersion .
Field Type Required Description activeboolean yes True for the active version, the one bindings that track active resolve at dispatch. chunk_countinteger yes configKnowledgeBaseConfig yes config_sha256string yes The SHA-256 of the canonical configuration, in lowercase hex. document_countinteger yes evaluation_idKnowledgeEvaluationId or nullyes The Evaluation the gate read, or null when none ran. excluded_document_countinteger yes The pending Documents exclude_pending left out; 0 when it was not set. excluded_document_idsarray of KnowledgeDocumentId yes The first 100 of them (a target), in id order. gateKnowledgeGateOutcome yes knowledge_base_idKnowledgeBaseId yes notesstring or null yes object"knowledge_base_version"yes published_atTimestamp yes published_byActorRef or nullyes Who published it; null when auto_publish published it after an Ingestion run. retired_atTimestamp or nullyes source_revisioninteger yes The draft revision whose configuration the version froze. statusKnowledgeBaseVersionStatus yes versioninteger yes The snapshot number, from 1.