Przejdź do głównej zawartości

Wyniki i pobieranie

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

Artefakty są widoczne tylko dla konta posiadacza. Przeczytaj listę po zakończeniu zadania.

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

Pobieranie obsługuje ETag i żądania warunkowe. Przepływ strumieniowy dużych plików na dysk zamiast wczytywania ich do pamięci RAM naraz.

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

Zwraca:

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

Klienci muszą również obsłużyć url jako null; następnie użyć bezpośredniego punktu końcowego pobierania. Pobierz nowy krótkoterminowy adres URL po wygaśnięciu poprzedniego.

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

Wyniki HTML, SVG i XML są zawsze pobierane jako załączniki.

Najpierw przetworz RFC 5987 i filename*, a następnie przełącz na filename. Niezależnie od wybranej opcji zachowaj tylko nazwę pliku bez ścieżki, a nielegalne znaki skróć lub zastąp zgodnie z zasadami lokalnego systemu plików.

Zadanie może zwrócić kilka artefaktów lub jeden spakowany wynik. Kieruj się wartością format w liście artefaktów oraz nagłówkami odpowiedzi pobranej; nie szacuj typu odpowiedzi na podstawie rozszerzenia pliku źródłowego.