Przejdź do głównej zawartości

Status zadania

GET /api/v1/jobs/{job_id}

Zapytanie tylko odczytuje status i nie zużywa żadnych kredytów.

Okno terminala
curl https://omnidoc.top/api/v1/jobs/q3f8s6c2a9m1k4tx \
-H "X-API-Key: $OMNIDOC_API_KEY"
statusZnaczenie
pendingUtworzono, oczekuje w kolejce
processingPrzetwarzane
completedZakończono; wyniki można odczytać
failedNiepowodzenie lub anulowanie; zobacz error_msg

status informuje, czy zadanie zostało zakończone.

stageZnaczenie
queuedW kolejce
accepted / preflightAkceptowane i przygotowywane
translatingTłumaczenie
writing_artifacts / finalizingGenerowanie i rejestrowanie wyników
completed / failedZakończono

stage_progress to wyświetlany postęp od 0 do 100; nie jest używany do rozliczeń. Podczas oczekiwania w kolejce queue_position może podawać liczbę zadań znajdujących się przed nim lub może być równy null.

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

Anulowanie jest realizowane w ramach najlepszych dostępnych starań; zadań, które już się zakończyły, zwracany jest kod 409. Za anulowane zadania nie pobierana jest opłata, co można potwierdzić w historii kredytów.

Po zakończeniu zadania:

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

Lista wyników jest pusta, podczas gdy zadanie nadal się wykonuje.