Bestanden uploaden
Het uploaden verloopt in drie stappen: vraag een uploadadres aan, verzend het bestand en bevestig het document. Een uploadadres kan één keer worden gegenereerd en is maximaal 1 uur geldig.
1. Vraag een uploadadres aan
Section titled “1. Vraag een uploadadres aan”POST /api/v1/upload/presignX-API-Key: sk_your_keyContent-Type: application/json{ "filename": "report.docx", "file_size": 45678}| Veld | Type | Vereist | Beschrijving |
|---|---|---|---|
filename | string | ✅ | Bestandsnaam; de server bepaalt het bestandstype aan de hand van de extensie |
file_size | geheel getal | ✅ | Exacte grootte in bytes, groter dan 0 |
mime_type | string | — | Optioneel; de server gebruikt het niet |
Antwoord:
{ "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. Stuur het bestand
Section titled “2. Stuur het bestand”Stuur een PUT naar upload_url met de ruwe bestandsbytes als body, en stuur elke header in upload_headers precies zoals opgegeven.
# 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"Stuur uw OmniDoc API-sleutel niet in deze stap. Als het adres verloopt of de overdracht mislukt, vraag dan een nieuwe aan.
3. Bevestig het document
Section titled “3. Bevestig het document”POST /api/v1/upload/finalizeX-API-Key: sk_your_keyContent-Type: application/json{"finalize_token":"short_lived_token"}Bij succes wordt het document geretourneerd:
{ "document": { "id": "4q8mx2q9z1k7p6ra", "basename": "report.docx", "file_size": 45678, "mime_type": "application/vnd.openxmlformats-officedocument.wordprocessingml.document", "created_at": "2026-10-01T12:00:00Z" }}Pas na bevestiging wordt het document in de bestandsbibliotheek opgenomen en beschikbaar voor taken.
Bestandsnamen
Section titled “Bestandsnamen”filename is uitsluitend bedoeld voor weergave; gebruik het niet als pad of unieke identifier. De server vervangt ongeldige tekens en genereert een veilige downloadnaam voor namen die te lang zijn.
Fouten
Section titled “Fouten”| Status | Oorzaak |
|---|---|
400 | Ongeldig bestandsnaam of -grootte, of de geüploade grootte wijkt af van de gevraagde |
401 | Referentie of finalize_token ongeldig of verlopen |
403 | De finalize_token behoort tot een ander account |
410 | Het geüploade bestand is niet gevonden (overdracht onvolledig of adres verlopen); vraag een nieuw adres aan |
413 | Overschrijdt de limiet voor bestandsgrootte |
415 | Niet-ondersteund formaat, of de inhoud komt niet overeen met de extensie |
422 | Het bestand Office is beschadigd of structureel onveilig |
429 | Te veel uploads |
503 | De uploadservice is tijdelijk niet beschikbaar; probeer het later opnieuw |