Ga naar inhoud

Taakstatus

GET /api/v1/jobs/{job_id}

Een query leest alleen de status en kost geen credits.

Terminal window
curl https://omnidoc.top/api/v1/jobs/q3f8s6c2a9m1k4tx \
-H "X-API-Key: $OMNIDOC_API_KEY"
statusBetekenis
pendingAangemaakt, wacht in de wachtrij
processingWordt verwerkt
completedVoltooid; resultaten kunnen worden gelezen
failedMislukt of geannuleerd; zie error_msg

status geeft aan of de taak is voltooid.

stageBetekenis
queuedIn de wachtrij
accepted / preflightGeaccepteerd en in voorbereiding
translatingVertalen
writing_artifacts / finalizingHet genereren en registreren van de resultaten
completed / failedBeëindigd

stage_progress is een weergave van de voortgang van 0 naar 100; het wordt niet gebruikt voor facturering. Terwijl er in de wachtrij staat, kan queue_position het aantal taken vóór deze taak aangeven, of het kan null zijn.

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

Annulering is op basis van inspanningsverplichting; een taak die al is beëindigd retourneert 409. Geannuleerde taken worden niet in rekening gebracht, wat u kunt controleren in het creditoverzicht.

Nadat de taak is voltooid:

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

De resultatenlijst is leeg terwijl de taak nog wordt uitgevoerd.