Read a Knowledge base
GET /v1/knowledge-bases/{knowledge_base_id}
Property Value Operation get_knowledge_baseGroup 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_..." \
-H "Authorization: Bearer $VOCAL_API_KEY"const response = await fetch(`${process.env.VOCAL_API}/v1/knowledge-bases/kb_...`, {
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_...",
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.
Responses
Fields of the 200 answer
The shape is KnowledgeBase .
Field Type Required Description active_versioninteger or null yes The version bindings that track active resolve at dispatch, or null when none is active. archived_atTimestamp or nullyes When DELETE archived the Knowledge base, or null. An archived Knowledge base takes no write, upload, sync or publish (409 knowledge_base_archived). auto_publishKnowledgeAutoPublish yes chunkingKnowledgeChunking yes created_atTimestamp yes descriptionstring or null yes document_countinteger no The Documents of the Knowledge base that are not removed, whatever their status (1.54.0); absent from an api before 1.54.0. embeddingKnowledgeEmbedding yes idKnowledgeBaseId yes languageLanguageTag yes latest_versioninteger or null yes The highest published version, or null before the first publish. nameKnowledgeBaseName yes object"knowledge_base"yes organization_idOrganizationId yes phi_contentKnowledgePhiContent yes retrieval_defaultsKnowledgeRetrievalDefaults yes revisioninteger yes Counts writes to the draft; returned as the ETag and required in If-Match. sensitive_contentKnowledgeSensitiveContent yes source_countinteger no The Sources of the Knowledge base that are not deleted (1.54.0); absent from an api before 1.54.0. updated_atTimestamp yes