Saltearse al contenido

Resultados y descargas

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

Los artefactos son visibles únicamente para la cuenta propietaria. Lea la lista una vez completada la tarea.

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

Las descargas admiten ETag y solicitudes condicionales. Transfiere archivos grandes al disco en lugar de cargarlos enteros en memoria.

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

Devuelve:

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

Los clientes también deben gestionar que url sea null; luego, utilizar el punto final de descarga directa. Obtener una nueva URL de corta duración una vez que la anterior expire.

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

Los resultados de HTML, SVG y XML siempre se descargan como archivos adjuntos.

Analice primero RFC 5987 filename* y, en su defecto, recurra a filename. Sea cual sea el método que utilice, conserve únicamente el nombre base del archivo y trunque o reemplace los caracteres no válidos según las reglas de su sistema de archivos local.

Un trabajo puede devolver varios artefactos o un único resultado empaquetado. Consulte el format en la lista de artefactos y las cabeceras de respuesta de descarga; no intente deducir el tipo de respuesta a partir de la extensión del archivo fuente.