Pular para o conteúdo

Resultados e downloads

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

Os artefatos são visíveis apenas para a conta proprietária. Leia a lista após a conclusão do job.

GET /api/v1/artifacts/{artifact_id}/download
Terminal window
curl --fail-with-body -OJ \
https://omnidoc.top/api/v1/artifacts/6n2b7z5q8v4m1c3k/download \
-H "X-API-Key: $OMNIDOC_API_KEY"

Suporta downloads ETag e requisições condicionais. Transfira arquivos grandes para o disco em vez de lê-los completamente na memória de uma só vez.

GET /api/v1/artifacts/{artifact_id}/download-link

Retorna:

{
"mode": "direct",
"url": "https://download.example/...",
"filename": "report.en.docx"
}

Os clientes também devem tratar url como null; em seguida, usar o ponto de extremidade de download direto. Obtenha uma nova URL de curta duração após a expiração da anterior.

GET /api/v1/artifacts/{artifact_id}/preview-url

Os resultados de HTML, SVG e XML são sempre baixados como anexos.

Analise primeiro RFC 5987 filename* e, em seguida, recorra a filename. Independentemente de qual você usar, mantenha apenas o nome base e trunque ou substitua caracteres inválidos de acordo com o sistema de arquivos local.

Um job pode retornar vários artefatos ou um único resultado empacotado. Consulte o format na lista de artefatos e os cabeçalhos da resposta de download; não tente inferir o tipo de resposta pela extensão do arquivo de origem.