Skip to main content
POST
Préparez l’envoi d’une référence JPG, PNG ou WebP de 8 MiB maximum. Utilisez thumbnails_upload_sign_parts pour obtenir les URL PUT, envoyez les octets, puis appelez thumbnails_upload_complete et utilisez son fileKey lors de la génération.

Authentification et autorisations

string
requis
Envoyez une clé API VoiceCheap dans cet en-tête. Authorization: Bearer avec la même clé API est également accepté. Les jetons d’accès OAuth sont acceptés uniquement par MCP, pas par cet endpoint REST.
Autorisations requises: thumbnails:write. Un abonnement payant actif est requis. Les autorisations ne modifient ni les rôles dans l’équipe, ni la propriété des ressources, ni les crédits média, ni les limites du forfait.

Paramètres

string
Facultatif au niveau du transport : le serveur injecte un identifiant avant la validation si ce champ est omis. Fournissez votre propre UUID v4 stable pour récupérer le résultat en toute sécurité si la réponse est perdue.Format: “uuid”. Motif: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$.
string
requis
Le nom du fichier image, avec une extension correspondant à contentType.Longueur minimale: 1. Longueur maximale: 250. Motif: \.(?:jpe?g|png|webp)$.
string
requis
Valeur textuelle.Valeurs acceptées: “image/jpeg”, “image/png”, “image/webp”.
integer
requis
Taille exacte du fichier en octets, jusqu’à 8 MiB.Minimum: 1. Maximum: 8388608.
Le JSON Schema ci-dessous conserve les noms de champs exacts, les types imbriqués, les valeurs par défaut, les limites et les valeurs acceptées exposés par la découverte. Les règles supplémentaires entre champs figurent dans les notes de l’opération.

Idempotence

Utilisez un UUID v4 dans requestId ou dans l’en-tête HTTP Idempotency-Key pour chaque mutation. Après une erreur réseau, réutilisez le même identifiant avec des arguments identiques. Si les deux sont fournis, ils doivent correspondre. Rejouer une requête enregistrée ne répète pas l’opération et ne décompte pas un nouvel appel mensuel. Les requêtes en échec ou interrompues ne sont pas relancées automatiquement. Toute mutation peut renvoyer HTTP 202 lorsqu’une nouvelle tentative retrouve la même requête encore en cours, même si sa première exécution est habituellement synchrone. Si l’exécution est terminée mais que resultStored vaut false, une nouvelle tentative renvoie HTTP 200 avec l’état de la requête enregistrée, au lieu du résultat d’origine. Récupérez le résultat avec l’action d’historique, de résultat ou de téléchargement de son domaine.

Exemples de requêtes

Remplacez les exemples d’identifiants de ressources et de clés média par des valeurs renvoyées pour votre compte. Conservez le même identifiant de requête lorsque vous réessayez la même mutation.

Réponse

Une première exécution réussie renvoie HTTP 200 avec le résultat de l’opération sous data. Une nouvelle tentative peut renvoyer à la place l’état de la requête enregistrée. L’exemple présente une réponse possible, sans tous les champs facultatifs. Une nouvelle session d’envoi multipartie d’image de référence, la future clé d’objet, la taille des parties en octets et le nombre maximal d’envois en parallèle. Cette action n’envoie aucun octet d’image et ne rend pas key prêt pour la génération.

Champs du résultat

Récupérer et suivre cette requête

Utilisez le même identifiant, même après une perte de connexion. Si resultStored vaut false, récupérez le résultat avec l’action d’historique, de résultat ou de téléchargement correspondante. Ne lancez jamais une seconde génération uniquement pour vérifier l’avancement.
HTTP 200

Notes de l’opération

  • Nécessite thumbnails:write ; aucune portée d’envoi supplémentaire n’est requise.
  • Les espaces en début et en fin de filename sont supprimés ; sa longueur doit être de 1–250 caractères et il doit se terminer par .jpg, .jpeg, .png ou .webp. Son extension doit correspondre à contentType : image/jpeg, image/png ou image/webp. fileSize est le nombre entier exact d’octets, de 1 à 8,388,608.
  • L’implémentation d’envoi partagée renvoie partSize à 5 MiB (5,242,880 octets) pour ces références. Un fichier de 5 MiB maximum utilise une partie ; un fichier plus volumineux jusqu’à 8 MiB en utilise deux. Demandez des URL PUT avec thumbnails_upload_sign_parts, envoyez les octets, puis appelez thumbnails_upload_complete.
  • Utilisez le fileKey renvoyé à la finalisation comme entrée de referenceImageKeys dans thumbnails_generate. Le résultat de l’initialisation utilise key, pas fileKey. Ne transmettez pas key à la génération avant la finalisation.
  • La session d’envoi de production expire après 24 heures. Les URL signées des parties expirent après une heure. La finalisation et l’annulation suppriment la session active ; sign-parts et complete renvoient ensuite Upload not found. Aucune des deux réponses ne contient de champ expiresAt.
  • Cette action utilise les créations et les envois de l’utilisateur connecté, y compris lorsque l’identifiant d’accès est connecté dans un contexte d’équipe.
  • Utilisez un requestId UUID v4 ou l’en-tête HTTP Idempotency-Key, et réutilisez-le avec des entrées identiques lors des nouvelles tentatives. La couche d’intégration enregistre chaque modification et renvoie son état ou son résultat enregistré sans la réexécuter. Une requête échouée ou interrompue n’est pas automatiquement relancée.
  • Le nom du fichier dans la clé d’objet est assaini et peut être raccourci. Conservez exactement la clé et uploadId renvoyés ; ne les construisez pas vous-même. Les octets de l’image sont validés lors de la génération, en complément de la taille et du type déclarés lors de l’envoi.

Utilisation

Chaque invocation réussie consomme un appel du quota mensuel API/MCP. Les crédits média et les quotas de génération propres à l’opération s’appliquent également.

Erreurs