Skip to content

Job status

GET /api/v1/jobs/{job_id}

A query only reads the status and costs no credits.

Terminal window
curl https://omnidoc.top/api/v1/jobs/q3f8s6c2a9m1k4tx \
-H "X-API-Key: $OMNIDOC_API_KEY"
statusMeaning
pendingCreated, waiting in the queue
processingBeing processed
completedFinished; results can be read
failedFailed or cancelled; see error_msg

status tells you whether the job has ended.

stageMeaning
queuedIn the queue
accepted / preflightAccepted and preparing
translatingTranslating
writing_artifacts / finalizingGenerating and registering the results
completed / failedEnded

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.

GET /api/v1/jobs?limit=20&before=2026-10-01T12:00:00Z
POST /api/v1/jobs/{job_id}/cancel

Cancellation is best effort; a job that has already ended returns 409. Cancelled jobs are not charged, which you can confirm in the credit record.

After the job completes:

GET /api/v1/artifacts?job_id={job_id}

The result list is empty while the job is still running.