Status do trabalho
GET /api/v1/jobs/{job_id}Uma consulta apenas lê o status e não consome créditos.
curl https://omnidoc.top/api/v1/jobs/q3f8s6c2a9m1k4tx \ -H "X-API-Key: $OMNIDOC_API_KEY"Estados do ciclo de vida
Seção intitulada “Estados do ciclo de vida”status | Significado |
|---|---|
pending | Criado, aguardando na fila |
processing | Em processamento |
completed | Concluído; os resultados podem ser lidos |
failed | Falhou ou foi cancelado; consulte error_msg |
status indica se o trabalho foi concluído.
Estágios de progresso
Seção intitulada “Estágios de progresso”stage | Significado |
|---|---|
queued | Na fila |
accepted / preflight | Aceito e em preparação |
translating | Traduzindo |
writing_artifacts / finalizing | Gerando e registrando os resultados |
completed / failed | Finalizado |
stage_progress é um progresso de exibição de 0 a 100; não é utilizado para faturamento. Enquanto estiver em fila, queue_position pode indicar o número de trabalhos à frente ou pode ser null.
Listar e cancelar
Seção intitulada “Listar e cancelar”GET /api/v1/jobs?limit=20&before=2026-10-01T12:00:00ZPOST /api/v1/jobs/{job_id}/cancelO cancelamento é realizado com base no melhor esforço; um job que já foi concluído retorna 409. Jobs cancelados não são cobrados, o que pode ser confirmado no registro de créditos.
Obtenha os resultados
Seção intitulada “Obtenha os resultados”Após a conclusão do trabalho:
GET /api/v1/artifacts?job_id={job_id}A lista de resultados está vazia enquanto a tarefa ainda está em execução.