Lewati ke konten

Hasil dan unduhan

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

Artefak hanya dapat dilihat oleh akun pemilik. Baca daftar tersebut setelah pekerjaan selesai.

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"

Unduhan mendukung ETag dan permintaan bersyarat. Alirkan file besar ke disk alih-alih membacanya ke dalam memori sekaligus.

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

Mengembalikan:

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

Klien juga harus menangani url menjadi null; kemudian gunakan endpoint unduhan langsung. Dapatkan URL baru yang berlaku singkat setelah yang lama kedaluwarsa.

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

Hasil HTML, SVG, dan XML selalu diunduh sebagai lampiran.

Parsir RFC 5987 filename* terlebih dahulu, lalu gunakan fallback ke filename. Apa pun yang Anda gunakan, pertahankan hanya nama dasarnya, dan potong atau ganti karakter yang tidak valid sesuai dengan sistem berkas setempat.

Sebuah pekerjaan dapat menghasilkan beberapa artefak atau satu hasil yang dikemas. Ikuti format pada daftar artefak dan header respons unduhan; jangan menebak jenis respons berdasarkan ekstensi file sumber.