Document List
Get all documents in the current RAG knowledge base. Results are typically returned in reverse chronological order of upload time.
Try It
GET
/documents/documentshttps://api-platform.ope.aiAuthentication
Uses Bearer Token authentication.
- Header:
Authorization: Bearer <token> - Example:
Authorization: Bearer sk-xxxxxx
Query Parameters
No query parameters are required.
Request Examples
- cURL
- JavaScript
curl -X GET "https://api-platform.ope.ai/documents/documents" \
-H "Authorization: Bearer $OPEAI_API_KEY"
const res = await fetch("https://api-platform.ope.ai/documents/documents", {
headers: {
Authorization: `Bearer ${process.env.OPEAI_API_KEY}`,
},
});
console.log(await res.json());
Response Example
{
"documents": [
{
"doc_id": "doc_1",
"filename": "handbook.pdf",
"upload_time": "2026-05-09T12:00:00Z",
"chunk_count": 18,
"status": "success",
"filepath": "/data/uploads/tenant_1/handbook.pdf"
}
]
}
Error Responses
| Status Code | Scenario | Description |
|---|---|---|
401 | Authentication failed | API Key is missing, invalid, or has insufficient permissions |
422 | Validation failed | Request format is incorrect |
500 | Query failed | Database query failed |