Prześlij pliki
Przesyłanie pliku odbywa się w trzech krokach: żądanie adresu przesyłania, wysłanie pliku, potwierdzenie dokumentu. Adres przesyłania można wygenerować raz i jest ważny przez maksymalnie 1 godzinę.
1. Poproś o adres przesyłania
Dział zatytułowany „1. Poproś o adres przesyłania”POST /api/v1/upload/presignX-API-Key: sk_your_keyContent-Type: application/json{ "filename": "report.docx", "file_size": 45678}| Pole | Typ | Wymagane | Opis |
|---|---|---|---|
filename | ciąg znaków | ✅ | Nazwa pliku; serwer określa typ pliku na podstawie rozszerzenia |
file_size | liczba całkowita | ✅ | Dokładny rozmiar w bajtach, większy niż 0 |
mime_type | ciąg znaków | — | Opcjonalne; serwer go nie wykorzystuje |
Odpowiedź:
{ "document_id": "4q8mx2q9z1k7p6ra", "upload_url": "https://upload.example/...", "upload_headers": { "Content-Type": "application/vnd.openxmlformats-officedocument.wordprocessingml.document", "If-None-Match": "*" }, "finalize_token": "short_lived_token", "expires_in": 3600}2. Wyślij plik
Dział zatytułowany „2. Wyślij plik”Wyślij PUT do upload_url z oryginalnymi bajtami pliku jako treścią i prześlij każdy nagłówek w upload_headers dokładnie tak, jak podano.
# UPLOAD_URL and UPLOAD_CONTENT_TYPE come from upload_url and upload_headers["Content-Type"] in the previous responsecurl --fail-with-body -X PUT "$UPLOAD_URL" \ -H "Content-Type: $UPLOAD_CONTENT_TYPE" \ -H "If-None-Match: *" \ --upload-file "report.docx"Nie wysyłaj klucza API OmniDoc w tym kroku. Jeśli adres wygaśnie lub przekazanie nie powiedzie się, poproś o nowy.
3. Potwierdź dokument
Dział zatytułowany „3. Potwierdź dokument”POST /api/v1/upload/finalizeX-API-Key: sk_your_keyContent-Type: application/json{"finalize_token":"short_lived_token"}W przypadku sukcesu dokument jest zwracany:
{ "document": { "id": "4q8mx2q9z1k7p6ra", "basename": "report.docx", "file_size": 45678, "mime_type": "application/vnd.openxmlformats-officedocument.wordprocessingml.document", "created_at": "2026-10-01T12:00:00Z" }}Dokument trafia do biblioteki plików i staje się dostępny do wykorzystania w zadaniach dopiero po potwierdzeniu.
Nazwy plików
Dział zatytułowany „Nazwy plików”filename służy wyłącznie do wyświetlania; nie należy go używać jako ścieżki lub unikalnego identyfikatora. Serwer zastępuje niedozwolone znaki i generuje bezpieczną nazwę pobrania dla nazw, które są zbyt długie.
| Status | Przyczyna |
|---|---|
400 | Nieprawidłowa nazwa pliku lub jego rozmiar, lub rozmiar przesłany różni się od żądanego. |
401 | Certyfikat lub finalize_token jest nieprawidłowy lub wygasły |
403 | finalize_token należy do innego konta |
410 | Nie znaleziono przesłanego pliku (przesyłka niezakończona lub adres wygasły); poproś o nowy adres |
413 | Przekracza limit rozmiaru pliku |
415 | Nieobsługiwany format lub zawartość nie odpowiada rozszerzeniu. |
422 | Plik Office jest uszkodzony lub niebezpieczny pod względem konstrukcji. |
429 | Zbyt wiele przesyłanych plików |
503 | Usługa przesyłania jest tymczasowo niedostępna; spróbuj ponownie później |