Tovább a tartalomhoz

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.

POST /api/v1/upload/presign
X-API-Key: sk_your_key
Content-Type: application/json
{
"filename": "report.docx",
"file_size": 45678
}
TérTípusKötelezőLeírás
filenamestring✅Fájlnév; a szerver a kiterjesztés alapján határozza meg a fájl típusát
file_sizeegész szám✅Pontos méret bájtokban, 0-nál nagyobb
mime_typestring—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
}

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.

Terminál
# 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"

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.

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

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.

ÁllapotOk
400Érvénytelen fájlnév vagy méret, vagy a feltöltött méret eltér a kért mérettől
401Hitelesítő adat vagy finalize_token érvénytelen vagy lejárt
403A finalize_token egy másik fiókhoz tartozik
410A feltöltött fájl nem található (átvitel hiányos vagy cím lejárt); kérjen új címet
413Meghaladja a fájlonkénti méretkorlátot
415Támogatott formátum nélkül, vagy a tartalom nem egyezik a kiterjesztéssel
422A Office fájl sérült vagy szerkezetileg biztonságosnak nem tekinthető.
429Túl sok feltöltés
503A feltöltési szolgáltatás ideiglenesen nem elérhető; kérjük, próbálja újra később.