Zum Inhalt springen

Ergebnisse und Downloads

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

Artefakte sind nur für das Besitzerkonto sichtbar. Lesen Sie die Liste nach Abschluss des Jobs.

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

Downloads unterstützen ETag und bedingte Anfragen. Große Dateien werden auf die Festplatte gestreamt, anstatt sie vollständig in den Speicher zu laden.

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

Rückgabe:

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

Clients müssen außerdem sicherstellen, dass url null ist; anschließend verwenden sie den direkten Download-Endpunkt. Nach Ablauf einer URL wird eine neue, kurzlebige URL abgerufen.

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

Die Ergebnisse von HTML, SVG und XML werden stets als Anhänge heruntergeladen.

Parsen Sie zuerst RFC 5987 filename* und greifen Sie anschließend auf filename zurück. Welche Methode Sie auch immer verwenden, behalten Sie nur den Basisnamen bei und kürzen oder ersetzen Sie ungültige Zeichen gemäß Ihrem lokalen Dateisystem.

Ein Job kann mehrere Artefakte oder ein verpacktes Ergebnis zurückgeben. Orientieren Sie sich an format in der Artefaktliste und den Download-Antwortköpfen; schließen Sie den Antworttyp nicht aus der Erweiterung der Quelldatei ab.