Salta ai contenuti

Risultati e download

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

Gli artifact sono visibili solo all’account proprietario. Leggi l’elenco al termine dell’esecuzione del 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"

Il download supporta ETag e le richieste condizionali. Scarica file di grandi dimensioni su disco anziché caricarli completamente in memoria.

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

Restituisce:

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

I clienti devono inoltre gestire url come null; quindi utilizzare l’endpoint di download diretto. Recuperare un nuovo URL a breve termine dopo la scadenza di quello precedente.

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

I risultati di HTML, SVG e XML vengono sempre scaricati come allegati.

Analizza prima RFC 5987 filename*, quindi ricorri a filename. Qualunque opzione tu scelga, mantieni solo il nome base del file e tronca o sostituisci i caratteri non validi in base al tuo sistema operativo locale.

Un job può restituire diversi artefatti oppure un unico risultato impacchettato. Fare riferimento al format nell’elenco degli artefatti e alle intestazioni della risposta di download; non dedurre il tipo di risposta dall’estensione del file sorgente.