Перейти до вмісту

Результати та завантаження

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 та умовні запити. Струмове передавання великих файлів на диск замість одночасного зчитування їх у пам’ять.

Стратегія завантаження

Section titled “Стратегія завантаження”
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 у списку артефактів та заголовки відповіді завантаження; не визначайте тип відповіді за допомогою розширення вихідного файлу.