Documents

Upload files and track processing status.

All endpoints require the dashboard X-Clerk-User-Id header.

Upload document

POST/kbs/{kb_id}/documents

Multipart file upload. Processing starts immediately.

curl

curl -X POST https://api.docubix.com/kbs/{kb_id}/documents -H "X-Clerk-User-Id: your_clerk_user_id" \
  -F "file=@biology.pdf"

json

{
  "id": "...",
  "filename": "biology.pdf",
  "status": "queued"
}

GET/kbs/{kb_id}/documents

curl

curl https://api.docubix.com/kbs/{kb_id}/documents -H "X-Clerk-User-Id: your_clerk_user_id"

GET/documents/{document_id}

GET/documents/{document_id}/job

Processing job progress.

Use PATCH /documents/{id} to rename and PUT /documents/{id}/file to replace the file.

POST/documents/{document_id}/retry

Only documents with status failed can be retried.

json

{
  "id": "...",
  "status": "queued"
}

DELETE/documents/{document_id}

json

{
  "success": true
}

Status	Meaning
queued	Waiting to start processing
extracting	Extracting text from the file
chunking	Splitting text into chunks
embedding	Generating vector embeddings
completed	Ready to query
failed	Processing failed — check error_message and retry