Skip to main content

List Documents

GET /agent/documents/:volume_id

List all documents in a volume with their processing status.

Request​

Path Parameters:

ParameterTypeDescription
volume_idstring (UUID)Volume ID

Response​

[
{
"document_id": "a1b2c3d4-...",
"filename": "team-handbook.pdf",
"mime_type": "application/pdf",
"file_size": 1048576,
"chunk_count": 42,
"status": "completed",
"created_at": "2024-01-15T10:30:00Z"
},
{
"document_id": "e5f6g7h8-...",
"filename": "notes.md",
"mime_type": "text/markdown",
"file_size": 4096,
"chunk_count": 3,
"status": "completed",
"created_at": "2024-01-14T08:00:00Z"
}
]

Document Status​

StatusDescription
processingDocument is being chunked and embedded
completedAll chunks embedded and indexed
failedIngestion failed (check metadata for error)

Example​

curl https://api.sharedmemory.ai/agent/documents/a1b2c3d4-... \
-H "Authorization: Bearer sm_agent_..."