Preskočiť na obsah

Stav úlohy

GET /api/v1/jobs/{job_id}

Dotaz iba číta stav a nestojí žiadne kredity.

Terminal window
curl https://omnidoc.top/api/v1/jobs/q3f8s6c2a9m1k4tx \
-H "X-API-Key: $OMNIDOC_API_KEY"
statusVýznam
pendingVytvorené, čaká vo fronte
processingSpracovávané
completedHotovo; výsledky je možné prečítať
failedNepodarilo sa alebo bolo zrušené; pozri error_msg

status vám informuje, či sa úloha ukončila.

stageVýznam
queuedV poradí
accepted / preflightAkceptované a pripravuje sa
translatingPrekladanie
writing_artifacts / finalizingGenerovanie a registrácia výsledkov
completed / failedUkončené

stage_progress je zobrazovanie priebehu od 0 do 100; nepoužíva sa na fakturáciu. Počas čakania v poradí môže queue_position uvádzať počet úloh pred aktuálnou, alebo môže byť null.

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

Zrušenie je vykonané v rámci snaženia; úloha, ktorá už skončila, vráti hodnotu 409. Za zrušené úlohy sa neúčtuje žiadna cena, čo môžete potvrdiť v registri kreditov.

Po dokončení úlohy:

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

Zoznam výsledkov je prázdny, zatiaľ čo úloha stále beží.