Aller au contenu

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.

POST /api/v1/upload/presign
X-API-Key: sk_your_key
Content-Type: application/json
{
"filename": "report.docx",
"file_size": 45678
}
ChampTypeObligatoireDescription
filenamechaîne de caractères✅Nom de fichier ; le serveur détermine le type de fichier à partir de l’extension
file_sizeentier✅Taille exacte en octets, supérieure à 0
mime_typechaî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
}

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é.

Fenêtre de terminal
# 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"

N’envoyez pas votre clé API OmniDoc à cette étape. Si l’adresse expire ou si le transfert échoue, demandez-en une nouvelle.

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

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.

ÉtatCause
400Nom ou taille de fichier invalide, ou la taille téléchargée diffère de celle demandée
401Identifiant ou finalize_token invalide ou expiré
403Le finalize_token appartient à un autre compte
410Le fichier téléchargé n’a pas été trouvé (transfert incomplet ou adresse expirée) ; veuillez demander une nouvelle adresse.
413Dépasse la limite de taille par fichier
415Format non pris en charge, ou le contenu ne correspond pas à l’extension
422Le fichier Office est endommagé ou structurellement instable.
429Trop de téléchargements
503Le service de téléchargement est temporairement indisponible ; veuillez réessayer plus tard.