Knowledge Base
Get Document
API key access
Needs the
kb:read scope with an API key (ro_pat_...). A signed-in session uses the caller's role.GET
/api/v1/kb/documents/{document_id}AuthorizationBearer <token>
Access token from /api/v1/auth/login, or an API key (ro_pat_..., RO-176) from /api/v1/workspaces/current/api-keys: the key implies its workspace and needs the route's scope. MCP connectors (/api/v1/mcp only) may use an OAuth access token (ro_oat_..., RO-284).
In: header
Path Parameters
document_idDocument Id
Format
uuidHeader Parameters
X-Workspace-Id?X-Workspace-Id
Id of the workspace to act on (must be a member).
Response Body
curl -X GET "http://localhost:8000/api/v1/kb/documents/497f6eca-6276-4993-bfeb-53cbbbba6f08" \ -H "X-Workspace-Id: string"{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"source_type": "url",
"source_url": "string",
"title": "string",
"content_type": "string",
"status": "pending",
"error": "string",
"char_count": 0,
"chunk_count": 0,
"embedding_model": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string",
"input": null,
"ctx": {}
}
]
}