Tovább a tartalomhoz

Eredmények és letöltések

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

Az artefaktumok csak a tulajdonos fiók számára láthatók. A feladat befejezése után olvassa el a listát.

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

A letöltések támogatják a ETag és a feltételhez kötött kéréseket. A nagy fájlokat a lemezre irányíthatja streameléssel, ahelyett hogy azokat egyszerre beolvasná a memóriába.

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

Visszatérési érték:

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

Az ügyfeleknek kezelniük kell azt is, hogy a url null; ezután használják a közvetlen letöltési végpontot. A lejárat után szerezzen be egy új, rövid életű URL-címet.

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

A HTML, SVG és XML eredmények mindig csatolmányként kerülnek letöltésre.

Először feldolgozza a RFC 5987 filename* részeket, majd térjen vissza a filename használatára. Bármelyik módszert is alkalmazza, csak az alapnevet tartsa meg, és a jogellenes karaktereket a helyi fájlrendszernek megfelelően rövidítse le vagy cserélje ki.

Egy feladat több műterméket vagy egy csomagolt eredményt is visszaadhat. A műterméklistában szereplő format és a letöltési válaszfejlécek alapján dönts; ne találgass a választípusról a forrásfájl kiterjesztéséből.