Overview
Credentials
Ollama
AI
Chat
Knowledge
MCP
Copy
curl -X GET https://api.example.com/api/knowledge/documents/doc_abc123 \
-H "Authorization: Bearer YOUR_API_KEY"
Copy
{
"success": true,
"document": {
"id": "doc_abc123",
"projectId": "proj_123",
"fileId": "file_xyz789",
"fileName": "product-guide.pdf",
"fileType": "pdf",
"sourceType": "upload",
"status": "completed",
"chunkCount": 45,
"vectorCount": 45,
"error": null,
"metadata": {
"size": 2048576,
"pages": 23,
"language": "en"
},
"createdAt": "2026-01-15T10:30:00Z",
"updatedAt": "2026-01-15T10:35:00Z"
}
}
Documents
Get RAG Document
Retrieves detailed information about a specific document
GET
/
api
/
knowledge
/
documents
/
{id}
Copy
curl -X GET https://api.example.com/api/knowledge/documents/doc_abc123 \
-H "Authorization: Bearer YOUR_API_KEY"
Copy
{
"success": true,
"document": {
"id": "doc_abc123",
"projectId": "proj_123",
"fileId": "file_xyz789",
"fileName": "product-guide.pdf",
"fileType": "pdf",
"sourceType": "upload",
"status": "completed",
"chunkCount": 45,
"vectorCount": 45,
"error": null,
"metadata": {
"size": 2048576,
"pages": 23,
"language": "en"
},
"createdAt": "2026-01-15T10:30:00Z",
"updatedAt": "2026-01-15T10:35:00Z"
}
}
Path Parameters
Document ID
Response
Whether the request was successful
Document details or null if not found
Show Document Object
Show Document Object
Document ID
Associated project ID
Associated file ID if applicable
Document file name
File type (pdf, txt, md, etc.)
Source type (upload, url, integration)
Processing status: pending, processing, completed, or failed
Number of chunks created from this document
Number of vectors stored
Error message if status is failed
Additional document metadata
ISO 8601 timestamp of creation
ISO 8601 timestamp of last update
Copy
curl -X GET https://api.example.com/api/knowledge/documents/doc_abc123 \
-H "Authorization: Bearer YOUR_API_KEY"
Copy
{
"success": true,
"document": {
"id": "doc_abc123",
"projectId": "proj_123",
"fileId": "file_xyz789",
"fileName": "product-guide.pdf",
"fileType": "pdf",
"sourceType": "upload",
"status": "completed",
"chunkCount": 45,
"vectorCount": 45,
"error": null,
"metadata": {
"size": 2048576,
"pages": 23,
"language": "en"
},
"createdAt": "2026-01-15T10:30:00Z",
"updatedAt": "2026-01-15T10:35:00Z"
}
}
⌘I