Sari la conținut

Încărcați fișiere

Încărcarea se face în trei etape: solicitare a adresei de încărcare, trimitere a fișierului, confirmare a documentului. O adresă de încărcare poate fi generată o singură dată și este valabilă până la 1 oră.

POST /api/v1/upload/presign
X-API-Key: sk_your_key
Content-Type: application/json
{
"filename": "report.docx",
"file_size": 45678
}
CâmpTipNecesarDescriere
filenameșir de caractere✅Numele fișierului; serverul determină tipul fișierului din extensie
file_sizenumăr întreg✅Dimensiunea exactă în octeți, mai mare decât 0
mime_typeșir de caractere—Opțional; serverul nu îl folosește

Răspuns:

{
"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
}

Trimiteți un PUT către upload_url cu octeții fișierului brut ca entitate, iar trimiteți fiecare capitol din upload_headers exact așa cum este prezentat.

Terminal window
# 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"

Nu trimiteți cheia API OmniDoc în această etapă. Dacă adresa expiră sau transferul nu reușește, solicitați una nouă.

POST /api/v1/upload/finalize
X-API-Key: sk_your_key
Content-Type: application/json
{"finalize_token":"short_lived_token"}

În cazul succesului, documentul este returnat:

{
"document": {
"id": "4q8mx2q9z1k7p6ra",
"basename": "report.docx",
"file_size": 45678,
"mime_type": "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
"created_at": "2026-10-01T12:00:00Z"
}
}

Doar după confirmare documentul este adăugat în biblioteca de fișiere și devine util pentru sarcini.

filename este doar pentru afișare; nu-l folosi ca și drum sau identificator unic. Serverul înlocuiește caracterele ilegale și generează un nume de descărcare sigur pentru numele prea lungi.

StareMotiv
400Numele sau dimensiunea fișierului este invalidă, sau dimensiunea încărcată diferă de cea solicitată
401Credențiale sau finalize_token invalide sau expirate
403finalize_token aparține unui alt cont
410Fișierul încărcat nu a fost găsit (transfer incomplet sau adresa expirată); solicitați o nouă adresă
413Excede limita de dimensiune per fișier
415Format neunterat sau conținutul nu corespunde extensiei
422Fișierul Office este deteriorat sau structuralmente instabil
429Prea multe încărcări
503Serviciul de încărcare este temporar indisponibil; încercați din nou mai târziu