Fájlok feltöltése
A feltöltés három lépésből áll: töltési cím kérése, fájl elküldése és dokumentum megerősítése. Egy töltési cím egyszer adható meg és legfeljebb 1 órán át érvényes.
1. Kérjen feltöltési címet
Szekció neve “1. Kérjen feltöltési címet”POST /api/v1/upload/presignX-API-Key: sk_your_keyContent-Type: application/json{ "filename": "report.docx", "file_size": 45678}| Tér | Típus | Kötelező | Leírás |
|---|---|---|---|
filename | string | ✅ | Fájlnév; a szerver a kiterjesztés alapján határozza meg a fájl típusát |
file_size | egész szám | ✅ | Pontos méret bájtokban, 0-nál nagyobb |
mime_type | string | — | Opcionális; a szerver nem használja fel |
Válasz:
{ "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. Küldje el a fájlt
Szekció neve “2. Küldje el a fájlt”Küldjön egy PUT -t a upload_url -re a nyers fájlbyte-okkal a testben, és küldje el minden fejlécet a upload_headers -ben pontosan úgy, ahogy megadva van.
# 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"Ne küldje el a OmniDoc API-kulcsát ebben a lépésben. Ha a cím lejár, vagy az átutalás sikertelen, kérjen újat.
3. Erősítse meg a dokumentumot
Szekció neve “3. Erősítse meg a dokumentumot”POST /api/v1/upload/finalizeX-API-Key: sk_your_keyContent-Type: application/json{"finalize_token":"short_lived_token"}Sikeres visszatérés esetén a dokumentumot adják vissza:
{ "document": { "id": "4q8mx2q9z1k7p6ra", "basename": "report.docx", "file_size": 45678, "mime_type": "application/vnd.openxmlformats-officedocument.wordprocessingml.document", "created_at": "2026-10-01T12:00:00Z" }}Csak a megerősítés után kerül a dokumentum a fájltárba, és válik a feladatokhoz használhatóvá.
Fájlnév
Szekció neve “Fájlnév”A filename csak megjelenítésre szolgál; ne használja útvonalként vagy egyedi azonosítóként. A szerver helyettesíti a jogellenes karaktereket, és biztonságos letöltési nevet generál a túl hosszú nevekhez.
Hibák
Szekció neve “Hibák”| Állapot | Ok |
|---|---|
400 | Érvénytelen fájlnév vagy méret, vagy a feltöltött méret eltér a kért mérettől |
401 | Hitelesítő adat vagy finalize_token érvénytelen vagy lejárt |
403 | A finalize_token egy másik fiókhoz tartozik |
410 | A feltöltött fájl nem található (átvitel hiányos vagy cím lejárt); kérjen új címet |
413 | Meghaladja a fájlonkénti méretkorlátot |
415 | Támogatott formátum nélkül, vagy a tartalom nem egyezik a kiterjesztéssel |
422 | A Office fájl sérült vagy szerkezetileg biztonságosnak nem tekinthető. |
429 | Túl sok feltöltés |
503 | A feltöltési szolgáltatás ideiglenesen nem elérhető; kérjük, próbálja újra később. |