Téléverser des fichiers
Le téléchargement se fait en trois étapes : demander une adresse de téléchargement, envoyer le fichier et confirmer le document. Une adresse de téléchargement peut être utilisée une seule fois et reste valide pendant 1 heure maximum.
1. Demander une adresse de téléchargement
Section intitulée « 1. Demander une adresse de téléchargement »POST /api/v1/upload/presignX-API-Key: sk_your_keyContent-Type: application/json{ "filename": "report.docx", "file_size": 45678}| Champ | Type | Obligatoire | Description |
|---|---|---|---|
filename | chaîne de caractères | ✅ | Nom de fichier ; le serveur détermine le type de fichier à partir de l’extension |
file_size | entier | ✅ | Taille exacte en octets, supérieure à 0 |
mime_type | chaîne de caractères | — | Facultatif ; le serveur ne l’utilise pas |
Réponse :
{ "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. Envoyez le fichier
Section intitulée « 2. Envoyez le fichier »Envoyez un PUT à upload_url en utilisant les octets du fichier brut comme corps, et transmettez chaque en-tête dans upload_headers exactement tel qu’indiqué.
# 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"N’envoyez pas votre clé API OmniDoc à cette étape. Si l’adresse expire ou si le transfert échoue, demandez-en une nouvelle.
3. Confirmez le document
Section intitulée « 3. Confirmez le document »POST /api/v1/upload/finalizeX-API-Key: sk_your_keyContent-Type: application/json{"finalize_token":"short_lived_token"}En cas de succès, le document est renvoyé :
{ "document": { "id": "4q8mx2q9z1k7p6ra", "basename": "report.docx", "file_size": 45678, "mime_type": "application/vnd.openxmlformats-officedocument.wordprocessingml.document", "created_at": "2026-10-01T12:00:00Z" }}Ce n’est qu’après confirmation que le document est intégré à la bibliothèque de fichiers et devient utilisable pour les tâches.
Noms de fichiers
Section intitulée « Noms de fichiers »filename est uniquement destiné à l’affichage ; n’en faites pas un chemin ou un identifiant unique. Le serveur remplace les caractères illégaux et génère un nom de téléchargement sécurisé pour les noms trop longs.
| État | Cause |
|---|---|
400 | Nom ou taille de fichier invalide, ou la taille téléchargée diffère de celle demandée |
401 | Identifiant ou finalize_token invalide ou expiré |
403 | Le finalize_token appartient à un autre compte |
410 | Le fichier téléchargé n’a pas été trouvé (transfert incomplet ou adresse expirée) ; veuillez demander une nouvelle adresse. |
413 | Dépasse la limite de taille par fichier |
415 | Format non pris en charge, ou le contenu ne correspond pas à l’extension |
422 | Le fichier Office est endommagé ou structurellement instable. |
429 | Trop de téléchargements |
503 | Le service de téléchargement est temporairement indisponible ; veuillez réessayer plus tard. |