Pular para o conteúdo

Status do trabalho

GET /api/v1/jobs/{job_id}

Uma consulta apenas lê o status e não consome créditos.

Terminal window
curl https://omnidoc.top/api/v1/jobs/q3f8s6c2a9m1k4tx \
-H "X-API-Key: $OMNIDOC_API_KEY"
statusSignificado
pendingCriado, aguardando na fila
processingEm processamento
completedConcluído; os resultados podem ser lidos
failedFalhou ou foi cancelado; consulte error_msg

status indica se o trabalho foi concluído.

stageSignificado
queuedNa fila
accepted / preflightAceito e em preparação
translatingTraduzindo
writing_artifacts / finalizingGerando e registrando os resultados
completed / failedFinalizado

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.

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

O 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.

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.