跳转到内容

Нәтижелер мен жүктеулер

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

Артефакттар тек иеленуші тіркеме үшін ғана көрінеді. Жұмыс аяқталғаннан кейін тізімді оқыңыз.

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"

Жүктеулер ETag және шартты сұрауларды қолдайды. Үлкен файлдарды бірден жадқа жүктемей, дискке ағынмен жазыңыз.

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

Қайтару:

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

Клиенттер сондай-ақ url болуын null ретінде өңдеуі керек; содан кейін тікелей жүктеу нүктесін пайдаланыңыз. Бір URL мерзімі өткен соң, жаңасын алыңыз.

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

HTML, SVG және XML нәтижелері әрқашан тіркеме ретінде жүктеледі.

Алдымен RFC 5987 filename*-ны талдаңыз, содан кейін filename-ге оралыңыз. Қайсысын пайдалансаңыз да, тек негізгі атауды қалдырыңыз және жергілікті файл жүйесіне сәйкес заңсыз таңбаларды қысқартыңыз немесе ауыстырыңыз.

Бір тапсырма бірнеше артефакт немесе бір пакеттелген нәтиже беруі мүмкін. Артефакттар тізіміндегі format және жүктеу жауаптың басылымдарына сүйеніңіз; жауап түрін дереккөздің файл кеңейтімінен болжамдамаңыз.