API Reference
Get Knowledge Base
GET /api/v1/knowledge-bases/:knowledgeBaseId — one Knowledge Base and its status.
GET /api/v1/knowledge-bases/{knowledgeBaseId}Response
200 OK
{
"knowledgeBaseId": "4f1c…",
"projectId": "2b7e…",
"name": "Pump manuals",
"status": "ACTIVE",
"embeddingLlmConfigId": "8b1e…",
"embeddingModel": "text-embedding-3-small",
"searchMode": "hybrid",
"hybridAlpha": 0.5,
"documentCount": 12,
"totalSizeBytes": 4812933,
"createdAt": "2026-10-09T08:00:00Z",
"updatedAt": "2026-10-09T08:05:00Z"
}| Field | Meaning |
|---|---|
status | ACTIVE (searchable, the state a new Knowledge Base starts in), INDEXING (re-indexing after a settings change) or FAILED. Per-document progress is in List documents. |
Errors
| Status | error | When |
|---|---|---|
403 | forbidden | Your key is scoped to a project and this Knowledge Base is in a different one. |
404 | not_found | No Knowledge Base with this id exists in your organization. |