Przejdź do głównej zawartości

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ę.

POST /api/v1/upload/presign
X-API-Key: sk_your_key
Content-Type: application/json
{
"filename": "report.docx",
"file_size": 45678
}
PoleTypWymaganeOpis
filenameciąg znaków✅Nazwa pliku; serwer określa typ pliku na podstawie rozszerzenia
file_sizeliczba całkowita✅Dokładny rozmiar w bajtach, większy niż 0
mime_typecią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
}

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.

Okno terminala
# UPLOAD_URL and UPLOAD_CONTENT_TYPE come from upload_url and upload_headers["Content-Type"] in the previous response
curl --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.

POST /api/v1/upload/finalize
X-API-Key: sk_your_key
Content-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.

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.

StatusPrzyczyna
400Nieprawidłowa nazwa pliku lub jego rozmiar, lub rozmiar przesłany różni się od żądanego.
401Certyfikat lub finalize_token jest nieprawidłowy lub wygasły
403finalize_token należy do innego konta
410Nie znaleziono przesłanego pliku (przesyłka niezakończona lub adres wygasły); poproś o nowy adres
413Przekracza limit rozmiaru pliku
415Nieobsługiwany format lub zawartość nie odpowiada rozszerzeniu.
422Plik Office jest uszkodzony lub niebezpieczny pod względem konstrukcji.
429Zbyt wiele przesyłanych plików
503Usługa przesyłania jest tymczasowo niedostępna; spróbuj ponownie później