List documents

GET /api/v1/knowledge-base/documents

Query parameters

Param	Type	Default	Notes
`status`	string	—	Filter by `processing_status` (`pending`, `processing`, `completed`, `failed`).
`limit`	int (1..100)	`100`
`offset`	int (≥0)	`0`

Response

{
  "documents": [
    {
      "id": 7,
      "document_uuid": "abc12345-...",
      "filename": "product-faq.pdf",
      "file_size_bytes": 532187,
      "file_hash": "sha256:...",
      "mime_type": "application/pdf",
      "processing_status": "completed",
      "processing_error": null,
      "total_chunks": 42,
      "retrieval_mode": "chunked",
      "custom_metadata": { "s3_key": "...", "source": "presigned_upload" },
      "docling_metadata": { /* parse metadata */ },
      "source_url": null,
      "created_at": "2026-06-10T08:30:00Z",
      "updated_at": "2026-06-10T08:31:12Z",
      "organization_id": 1,
      "created_by": 5,
      "is_active": true
    }
  ],
  "total": 21,
  "limit": 100,
  "offset": 0
}

Examples

curl "https://dashboard.zoxa.ai/api/v1/knowledge-base/documents?status=completed&limit=50" \
  -H "X-API-Key: zsk_..."

Query parameters

Response

Examples

On this page