CAI APIAPI Reference

Jobs and Exports

Processing can run asynchronously. When a task_id is returned for an upload, use it to check job status.

Job status

Endpoint: GET /api/v1/job/{job_id}/status

curl -H "Authorization: Bearer $CAI_TOKEN" \
  "$CAI_BASE_URL/api/v1/job/$TASK_ID/status"

Export classifications as CSV

Endpoint: GET /api/v1/classifications/export-csv

curl -H "Authorization: Bearer $CAI_TOKEN" \
  "$CAI_BASE_URL/api/v1/classifications/export-csv?project_id=$CAI_PROJECT_ID" \
  -o classifications.csv

Download files and scans

  • File download: GET /api/v1/documents/{file_key}/download
  • Scan download: GET /api/v1/documents/{file_key}/scan
curl -H "Authorization: Bearer $CAI_TOKEN" \
  "$CAI_BASE_URL/api/v1/documents/$FILE_KEY/download" \
  -o original-file