Stato del lavoro
GET /api/v1/jobs/{job_id}Una query legge solo lo stato e non consuma crediti.
curl https://omnidoc.top/api/v1/jobs/q3f8s6c2a9m1k4tx \ -H "X-API-Key: $OMNIDOC_API_KEY"Stati del ciclo di vita
Sezione intitolata “Stati del ciclo di vita”status | Significato |
|---|---|
pending | Creato, in attesa nella coda |
processing | In elaborazione |
completed | Operazione completata; i risultati sono disponibili per la lettura. |
failed | Operazione non riuscita o annullata; vedere error_msg |
status indica se l’operazione è terminata.
Fasi di avanzamento
Sezione intitolata “Fasi di avanzamento”stage | Significato |
|---|---|
queued | Nella coda |
accepted / preflight | Accettato e in preparazione |
translating | Traduzione |
writing_artifacts / finalizing | Generazione e registrazione dei risultati |
completed / failed | Terminato |
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.
Elenco e annulla
Sezione intitolata “Elenco e annulla”GET /api/v1/jobs?limit=20&before=2026-10-01T12:00:00ZPOST /api/v1/jobs/{job_id}/cancelL’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.
Ottieni i risultati
Sezione intitolata “Ottieni i risultati”Al completamento dell’operazione:
GET /api/v1/artifacts?job_id={job_id}L’elenco dei risultati è vuoto mentre il processo è ancora in esecuzione.