Get document metadata, processing status, and source connector details.
OAuth scope: api:read.
GET
/api/v2/knowledge/{knowledgeBaseId}/documents/{documentId}X-API-Key<token>
Your Sim API key, personal or workspace-scoped. Generate one under Settings, then API Keys. Operations that reject workspace keys say so in their own description.
In: header
Path Parameters
documentId*string
Unique knowledge document identifier.
Length
1 <= lengthknowledgeBaseId*string
Unique knowledge base identifier.
Length
1 <= lengthQuery Parameters
workspaceId*string
Workspace that owns the knowledge base.
Length
1 <= lengthResponse Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://www.sim.ai/api/v2/knowledge/string/documents/string?workspaceId=string" \ -H "X-API-Key: YOUR_API_KEY"{
"data": {
"id": "b2d4f8a0-1c3e-4a5b-9d7c-2e6f0a8b4c12",
"knowledgeBaseId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"filename": "getting-started.pdf",
"fileSize": 248913,
"mimeType": "application/pdf",
"processingStatus": "completed",
"chunkCount": 24,
"tokenCount": 8123,
"characterCount": 41205,
"enabled": true,
"createdAt": "2025-06-18T16:45:00Z",
"tags": {
"category": "billing",
"priority": 2
},
"processingError": "string",
"processingStartedAt": "2025-06-18T16:45:05Z",
"processingCompletedAt": "2025-06-18T16:45:42Z",
"connectorId": "string",
"connectorType": "string",
"sourceUrl": "string"
}
}{
"error": {
"code": "BAD_REQUEST",
"message": "Invalid request"
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "Authentication required"
}
}{
"error": {
"code": "FORBIDDEN",
"message": "Insufficient workspace permissions",
"details": {
"code": "INSUFFICIENT_WORKSPACE_ROLE"
}
}
}{
"error": {
"code": "NOT_FOUND",
"message": "Not found"
}
}{
"error": {
"code": "RATE_LIMITED",
"message": "API rate limit exceeded",
"details": {
"retryAfter": "2026-01-01T00:00:30.000Z"
}
}
}{
"error": {
"code": "INTERNAL_ERROR",
"message": "Internal server error"
}
}{
"error": {
"code": "SERVICE_UNAVAILABLE",
"message": "Service temporarily unavailable"
}
}