Salta ai contenuti

Stato del lavoro

GET /api/v1/jobs/{job_id}

Una query legge solo lo stato e non consuma crediti.

Terminal window
curl https://omnidoc.top/api/v1/jobs/q3f8s6c2a9m1k4tx \
-H "X-API-Key: $OMNIDOC_API_KEY"
statusSignificato
pendingCreato, in attesa nella coda
processingIn elaborazione
completedOperazione completata; i risultati sono disponibili per la lettura.
failedOperazione non riuscita o annullata; vedere error_msg

status indica se l’operazione è terminata.

stageSignificato
queuedNella coda
accepted / preflightAccettato e in preparazione
translatingTraduzione
writing_artifacts / finalizingGenerazione e registrazione dei risultati
completed / failedTerminato

stage_progress è un indicatore di avanzamento che va da 0 a 100; non viene utilizzato per la fatturazione. Durante la fase di attesa, queue_position può indicare il numero di lavori precedenti oppure può essere null.

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

L’annullamento è effettuato con la massima diligenza; un lavoro già terminato restituisce 409. I lavori annullati non vengono addebitati, come è possibile verificare nel registro dei crediti.

Al completamento dell’operazione:

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

L’elenco dei risultati è vuoto mentre il processo è ancora in esecuzione.