Î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ă.
1. Solicitați o adresă de încărcare
Section titled “1. Solicitați o adresă de încărcare”POST /api/v1/upload/presignX-API-Key: sk_your_keyContent-Type: application/json{ "filename": "report.docx", "file_size": 45678}| Câmp | Tip | Necesar | Descriere |
|---|---|---|---|
filename | șir de caractere | ✅ | Numele fișierului; serverul determină tipul fișierului din extensie |
file_size | numă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}2. Trimite fișierul
Section titled “2. Trimite fișierul”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.
# 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"Nu trimiteți cheia API OmniDoc în această etapă. Dacă adresa expiră sau transferul nu reușește, solicitați una nouă.
3. Confirmați documentul
Section titled “3. Confirmați documentul”POST /api/v1/upload/finalizeX-API-Key: sk_your_keyContent-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.
Numele fișierelor
Section titled “Numele fișierelor”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.
| Stare | Motiv |
|---|---|
400 | Numele sau dimensiunea fișierului este invalidă, sau dimensiunea încărcată diferă de cea solicitată |
401 | Credențiale sau finalize_token invalide sau expirate |
403 | finalize_token aparține unui alt cont |
410 | Fișierul încărcat nu a fost găsit (transfer incomplet sau adresa expirată); solicitați o nouă adresă |
413 | Excede limita de dimensiune per fișier |
415 | Format neunterat sau conținutul nu corespunde extensiei |
422 | Fișierul Office este deteriorat sau structuralmente instabil |
429 | Prea multe încărcări |
503 | Serviciul de încărcare este temporar indisponibil; încercați din nou mai târziu |