Job status
GET /api/v1/jobs/{job_id}A query only reads the status and costs no credits.
curl https://omnidoc.top/api/v1/jobs/q3f8s6c2a9m1k4tx \ -H "X-API-Key: $OMNIDOC_API_KEY"Lifecycle states
Section titled “Lifecycle states”status | Meaning |
|---|---|
pending | Created, waiting in the queue |
processing | Being processed |
completed | Finished; results can be read |
failed | Failed or cancelled; see error_msg |
status tells you whether the job has ended.
Progress stages
Section titled “Progress stages”stage | Meaning |
|---|---|
queued | In the queue |
accepted / preflight | Accepted and preparing |
translating | Translating |
writing_artifacts / finalizing | Generating and registering the results |
completed / failed | Ended |
stage_progress is a display progress from 0 to 100; it is not used for billing. While queued, queue_position may give the number of jobs ahead, or may be null.
List and cancel
Section titled “List and cancel”GET /api/v1/jobs?limit=20&before=2026-10-01T12:00:00ZPOST /api/v1/jobs/{job_id}/cancelCancellation is best effort; a job that has already ended returns 409. Cancelled jobs are not charged, which you can confirm in the credit record.
Get the results
Section titled “Get the results”After the job completes:
GET /api/v1/artifacts?job_id={job_id}The result list is empty while the job is still running.