Skip to main content
GET
/
api
/
knowledge-base
/
{documentation_id}
Get Document
curl --request GET \
  --url https://api.example.com/api/knowledge-base/{documentation_id} \
  --header 'X-API-Key: <x-api-key>' \
  --header 'X-Organization-Id: <x-organization-id>'
{
  "success": true,
  "data": {
    "documentation_id": "doc_a1b2c3d4e5f6",
    "name": "Product Manual.pdf",
    "type": "file",
    "client_id": "org_abc123",
    "s3_key": "knowledge-base/org_abc123/doc_a1b2c3d4e5f6.pdf",
    "s3_uri": "s3://bucket/knowledge-base/org_abc123/doc_a1b2c3d4e5f6.pdf",
    "content_type": "application/pdf",
    "size": 2450000,
    "filename": "Product Manual.pdf",
    "processing_status": "completed",
    "page_count": 42,
    "vector_count": 156,
    "last_processed_at": "2024-01-16T14:45:00Z",
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-01-16T14:45:00Z"
  }
}
Get details of a specific knowledge base document.

Headers

X-API-Key
string
required
Your API key for authentication.
X-Organization-Id
string
required
The organization ID.

Path Parameters

documentation_id
string
required
The unique identifier of the document (format: doc_[a-f0-9]{12,}).

Permissions

  • kb:read (all roles)

Response

success
boolean
Indicates if the request was successful.
data
object
The full document object.
{
  "success": true,
  "data": {
    "documentation_id": "doc_a1b2c3d4e5f6",
    "name": "Product Manual.pdf",
    "type": "file",
    "client_id": "org_abc123",
    "s3_key": "knowledge-base/org_abc123/doc_a1b2c3d4e5f6.pdf",
    "s3_uri": "s3://bucket/knowledge-base/org_abc123/doc_a1b2c3d4e5f6.pdf",
    "content_type": "application/pdf",
    "size": 2450000,
    "filename": "Product Manual.pdf",
    "processing_status": "completed",
    "page_count": 42,
    "vector_count": 156,
    "last_processed_at": "2024-01-16T14:45:00Z",
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-01-16T14:45:00Z"
  }
}