Ga naar inhoud

Resultaten en downloads

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

Artefacten zijn alleen zichtbaar voor het eigenende account. Lees de lijst nadat de taak is voltooid.

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"

Downloads ondersteunen ETag en voorwaardelijke verzoeken. Stream grote bestanden naar de schijf in plaats van ze in één keer in het geheugen te lezen.

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

Retourwaarden:

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

Clients moeten ook url als null behandelen; gebruik vervolgens het directe download-eindpunt. Haal een nieuwe tijdelijke URL op nadat de vorige is verlopen.

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

De resultaten van HTML, SVG en XML worden altijd als bijlagen gedownload.

Verwerk eerst RFC 5987 en filename*, en gebruik vervolgens filename. Welke u ook gebruikt, behoud alleen de basisnaam en knip ongeldige tekens af of vervang ze volgens uw lokale bestandssysteem.

Een taak kan meerdere artefacten of één verpakt resultaat retourneren. Volg de format in de artefactlijst en de downloadresponsheaders; gis niet over het antwoordtype op basis van de extensie van het bronbestand.