Přeskočit na obsah

Stav úlohy

GET /api/v1/jobs/{job_id}

Dotaz pouze čte stav a neplatí žádné kredity.

Terminál
curl https://omnidoc.top/api/v1/jobs/q3f8s6c2a9m1k4tx \
-H "X-API-Key: $OMNIDOC_API_KEY"
statusVýznam
pendingVytvořeno, čeká ve frontě
processingZpracovává se
completedHotovo; výsledky lze přečíst
failedNevydařilo se nebo bylo zrušeno; viz error_msg

status vám sdělí, zda byl úkol ukončen.

stageVýznam
queuedVe frontě
accepted / preflightPřijato a připravuje se
translatingPřekládání
writing_artifacts / finalizingGenerování a registrace výsledků
completed / failedUkončeno

stage_progress je zobrazení průběhu od 0 do 100; nepoužívá se pro fakturaci. Když je v frontě, queue_position může uvádět počet úloh před ním nebo může být null.

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

Zrušení je prováděno nejlepšími snahami; úloha, která již skončila, vrátí hodnotu 409. Za zrušené úlohy se neúčtuje žádná částka, což můžete potvrdit v registru kreditů.

Po dokončení úlohy:

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

Seznam výsledků je prázdný, zatímco úloha stále běží.