> ## Documentation Index > Fetch the complete documentation index at: https://api-docs.voicecheap.ai/docs/llms.txt > Use this file to discover all available pages before exploring further. # Générer une miniature YouTube > Générez une miniature de 1280×720 pour le compte connecté, avec le quota média de l’application web. Réutilisez requestId lorsque vous réessayez la même requête ; utilisez thumbnails_download pour récupérer le résultat. Générez une miniature de 1280×720 pour le compte connecté, avec le quota média de l’application web. Réutilisez requestId lorsque vous réessayez la même requête ; utilisez thumbnails\_download pour récupérer le résultat. ```http theme={null} POST https://api.voicecheap.ai/v1/actions/thumbnails_generate ``` ## Authentification et autorisations 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 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}$`. Valeur textuelle. Longueur minimale: 10. Longueur maximale: 1200. Liste de valeurs. Consultez le schéma d’entrée complet pour connaître la structure de ses éléments. Nombre maximal d’éléments: 3. Valeur par défaut: \[]. 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. ```json theme={null} { "type": "object", "properties": { "requestId": { "type": "string", "format": "uuid", "pattern": "^[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}$", "description": "UUID v4 for this action. Reuse the same ID with identical arguments on retries." }, "prompt": { "type": "string", "minLength": 10, "maxLength": 1200 }, "referenceImageKeys": { "default": [], "maxItems": 3, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 512, "description": "An uploaded JPG, PNG or WebP object key under uploads/{yourUserId}/. Remote URLs are not accepted." } } }, "required": ["prompt"], "additionalProperties": false } ``` ## 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. ```bash cURL theme={null} curl --request POST 'https://api.voicecheap.ai/v1/actions/thumbnails_generate' \ --header "x-api-key: $VOICECHEAP_API_KEY" \ --header 'Content-Type: application/json' \ --data '{"requestId":"2fcb6b7f-4e5d-421a-b35b-b68548dfd83e","prompt":"A clean YouTube thumbnail showing a mountain sunrise, with the text “A new adventure”.","referenceImageKeys":["uploads/example-user/2502829e-3fde-4aad-b3c7-ce0f779fa2e6-reference.png"]}' ``` ```javascript JavaScript theme={null} const input = { requestId: '2fcb6b7f-4e5d-421a-b35b-b68548dfd83e', prompt: 'A clean YouTube thumbnail showing a mountain sunrise, with the text “A new adventure”.', referenceImageKeys: ['uploads/example-user/2502829e-3fde-4aad-b3c7-ce0f779fa2e6-reference.png'], }; const response = await fetch('https://api.voicecheap.ai/v1/actions/thumbnails_generate', { method: 'POST', headers: { 'x-api-key': process.env.VOICECHEAP_API_KEY, 'Content-Type': 'application/json', }, body: JSON.stringify(input), }); const body = await response.json(); if (!response.ok) throw new Error(body.code + ': ' + body.message); console.log(body); ``` ```python Python theme={null} import os import requests response = requests.post( "https://api.voicecheap.ai/v1/actions/thumbnails_generate", headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]}, json={"requestId": "2fcb6b7f-4e5d-421a-b35b-b68548dfd83e", "prompt": "A clean YouTube thumbnail showing a mountain sunrise, with the text “A new adventure”.", "referenceImageKeys": ["uploads/example-user/2502829e-3fde-4aad-b3c7-ce0f779fa2e6-reference.png"]}, timeout=120, ) body = response.json() if not response.ok: raise RuntimeError(f"{body.get('code')}: {body.get('message')}") print(body) ``` ## Réponse Cette opération renvoie HTTP 202 pendant son exécution. Conservez requestId et interrogez action\_request\_get avec cet identifiant et le nom de l’opération d’origine. Les états de suivi sont running, completed, failed et interrupted. Un résultat terminé peut renvoyer vers une tâche média distincte ; poursuivez avec l’action de statut ou de résultat propre à l’opération. Métadonnées finales de la miniature renvoyées à la fin de la génération. Le résultat mesure 1280 × 720 pixels ; les octets de l’image, previewDataUrl et les jetons de transfert ne sont pas inclus. ```json HTTP 202 theme={null} { "data": { "requestId": "2fcb6b7f-4e5d-421a-b35b-b68548dfd83e", "status": "running", "pollAction": "action_request_get", "pollAfterSeconds": 5 }, "requestId": "2fcb6b7f-4e5d-421a-b35b-b68548dfd83e" } ``` ```json HTTP 200 theme={null} { "data": { "generationId": "109c61cb35dbdc01a94aabb3b1a128519ed1f8823800a7a327b9d8d8c2c0e10b", "status": "completed", "width": 1280, "height": 720, "referenceImageCount": 1, "createdAt": 1792144800000, "updatedAt": 1792144800000, "expiresAt": 1792749600000 }, "requestId": "2fcb6b7f-4e5d-421a-b35b-b68548dfd83e" } ``` ```json HTTP 202 replay_running theme={null} { "data": { "requestId": "2fcb6b7f-4e5d-421a-b35b-b68548dfd83e", "operation": "thumbnails_generate", "createdAt": 1792144800000, "updatedAt": 1792144820000, "status": "running", "pollAfterSeconds": 5 }, "requestId": "2fcb6b7f-4e5d-421a-b35b-b68548dfd83e" } ``` ```json HTTP 200 replay_completed_without_result theme={null} { "data": { "requestId": "2fcb6b7f-4e5d-421a-b35b-b68548dfd83e", "operation": "thumbnails_generate", "createdAt": 1792144800000, "updatedAt": 1792144820000, "status": "completed", "resultStored": false, "message": "The action completed. Retrieve its output from the corresponding history or resource action." }, "requestId": "2fcb6b7f-4e5d-421a-b35b-b68548dfd83e" } ``` ## Champs du résultat | Champ | Description | | - | - | | `data.generationId` | Identifiant à transmettre tel quel à thumbnails\_get ou thumbnails\_download. | | `data.status` | completed, expired ou deleted. Un enregistrement deleted conserve cet état même après sa date d’expiration. | | `data.width` | Largeur de sortie en pixels : 1280. | | `data.height` | Hauteur du résultat en pixels : 720. | | `data.referenceImageCount` | Nombre d’images de référence utilisées : de 0 à 3. | | `data.createdAt` | Date de création en millisecondes Unix. | | `data.updatedAt` | Date de dernière mise à jour en millisecondes Unix. | | `data.expiresAt` | Date en millisecondes Unix après laquelle la miniature générée ne peut plus être téléchargée. | ## 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. ```bash theme={null} curl --request POST 'https://api.voicecheap.ai/v1/actions/action_request_get' \ --header "x-api-key: $VOICECHEAP_API_KEY" \ --header 'Content-Type: application/json' \ --data '{"requestId":"2fcb6b7f-4e5d-421a-b35b-b68548dfd83e","operation":"thumbnails_generate"}' ``` ```json HTTP 200 theme={null} { "data": { "requestId": "2fcb6b7f-4e5d-421a-b35b-b68548dfd83e", "operation": "thumbnails_generate", "status": "completed", "createdAt": 1792144800000, "updatedAt": 1792144820000, "resultStored": true, "result": { "generationId": "109c61cb35dbdc01a94aabb3b1a128519ed1f8823800a7a327b9d8d8c2c0e10b", "status": "completed", "width": 1280, "height": 720, "referenceImageCount": 1, "createdAt": 1792144800000, "updatedAt": 1792144800000, "expiresAt": 1792749600000 } } } ``` ## Notes de l’opération * Exige thumbnails:write. Les espaces en début et en fin du prompt sont supprimés ; il doit contenir 10–1200 caractères et est également normalisé avant la génération. referenceImageKeys vaut \[] par défaut et accepte au maximum trois clés. * Cette action prend du temps. La réponse API/MCP initiale indique normalement running ; interrogez régulièrement action\_request\_get avec l’opération thumbnails\_generate et le même requestId pour obtenir le résultat final présenté ici. * Utilise le quota quotidien habituel de génération de miniatures du compte. Les nouvelles miniatures du compte expirent sept jours après leur création ; téléchargez le résultat avant 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. * Les clés de référence doivent pointer vers des envois terminés sous uploads/\{yourUserId}/ et se terminer par .jpg, .jpeg, .png ou .webp. Les URL distantes, les clés d’autres utilisateurs, les segments de traversée de répertoire, les barres obliques inverses, les séquences d’échappement avec pourcentage, les chaînes de requête, les fragments et les caractères de contrôle sont refusés. * Chaque référence doit être non vide, ne pas dépasser 8 MiB (8,388,608 octets), pouvoir être décodée comme le type d’image indiqué par son extension et mesurer 128–4096 pixels de chaque côté. Le nombre de pixels décodés est également limité. Une référence envoyée reste réutilisable ; ces actions de génération ne consomment ni ne suppriment son fichier envoyé. * 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. * Une requête terminée peut renvoyer la miniature existante. Une requête d’intégration précédemment échouée ou interrompue n’est pas réexécutée automatiquement. Vérifiez l’état de la requête et thumbnails\_list avant de lancer une nouvelle requête. * Utilisez thumbnails\_get ou thumbnails\_list pour les métadonnées et thumbnails\_download pour les octets WebP. L’identifiant de génération est une chaîne opaque, et non requestId. ## 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 | Statut HTTP | Code | Signification ou solution | | - | - | - | | 400 | `CREDENTIAL_IN_QUERY` | Des identifiants ont été fournis dans un paramètre de requête access\_token ou api\_key. Envoyez les identifiants dans les en-têtes. | | 400 | `IDEMPOTENCY_CONFLICT` | L’en-tête Idempotency-Key et le champ requestId du corps doivent correspondre. | | 400 | `INVALID_REQUEST_ID` | requestId ou Idempotency-Key n’est pas un UUID v4. | | 400 | `REFERENCE_IMAGE_INVALID` | Une clé de référence ou ses octets échouent aux vérifications de propriété, de type, de taille, de dimensions ou de décodage. | | 400 | `THUMBNAIL_PROMPT_INVALID` | Le prompt normalisé ne respecte pas la plage de 10–1200 caractères. | | 400 | `VALIDATION_ERROR` | Un argument est manquant, contient une valeur non prise en charge, dépasse sa limite ou ne fait pas partie du schéma d’entrée strict. | | 401 | `API_KEY_EXPIRED` | La clé API a expiré. | | 401 | `INVALID_API_KEY` | Fournissez une clé API valide et non expirée. | | 401 | `INVALID_CREDENTIAL` | L’en-tête Authorization est mal formé ou entre en conflit avec x-api-key. | | 401 | `MISSING_CREDENTIAL` | Aucun identifiant d’authentification utilisable n’a été fourni dans les en-têtes, ou il dépassait 4096 caractères. | | 401 | `USER_NOT_FOUND` | Le compte associé à l’identifiant d’accès n’existe plus. | | 403 | `ACCOUNT_UNAVAILABLE` | Le compte à l’origine de l’action ou le compte de facturation est indisponible ou en cours de suppression. | | 403 | `AMBIGUOUS_TEAM_API_KEY` | L’utilisateur associé aux identifiants d’authentification appartient à plusieurs équipes, ce qui rend le contexte de facturation ambigu. | | 403 | `INSUFFICIENT_SCOPE` | Accordez toutes les autorisations requises ou choisissez d’autres identifiants d’accès. | | 403 | `INTEGRATION_PLAN_UNSUPPORTED` | Les limites d’intégration du compte n’ont pas pu être vérifiées. | | 403 | `SUBSCRIPTION_REQUIRED` | Utilisez un abonnement payant actif. | | 403 | `TEAM_OWNER_NOT_FOUND` | Le compte du propriétaire effectif de l’équipe est introuvable. | | 409 | `CONCURRENT_ACTION_LIMIT_REACHED` | Ce compte a déjà 10 actions d’intégration en cours. Suivez une requête existante avant d’en démarrer une autre. | | 409 | `IDEMPOTENCY_CONFLICT` | L’identifiant de requête a déjà été utilisé avec des arguments différents ; une divergence entre les identifiants de l’en-tête et du corps renvoie HTTP 400 avec le même code. | | 409 | `THUMBNAIL_GENERATION_IN_PROGRESS` | La requête de miniature est déjà en cours de traitement. | | 409 | `THUMBNAIL_REQUEST_FAILED` | Cette tentative de miniature a précédemment échoué. Examinez son état avant de décider de lancer une nouvelle requête. | | 409 | `THUMBNAIL_REQUEST_ID_REUSED` | L’identifiant de requête de miniature est déjà associé à une entrée différente. | | 410 | `THUMBNAIL_NOT_FOUND` | Le résultat précédemment terminé de cette requête a expiré ou n’est plus disponible. | | 422 | `THUMBNAIL_REQUEST_REJECTED` | La miniature ne peut pas être générée à partir de ce prompt ou de cette référence. Modifiez le contenu pour une nouvelle requête. | | 429 | `INTEGRATION_MONTHLY_LIMIT_REACHED` | Attendez la réinitialisation mensuelle ou changez de forfait. | | 429 | `INTEGRATION_RATE_LIMIT_REACHED` | Respectez Retry-After lorsqu’il est présent et espacez progressivement les nouvelles tentatives. | | 429 | `THUMBNAIL_DAILY_LIMIT_REACHED` | Le quota quotidien de génération de miniatures du compte est épuisé. | | 500 | `INTERNAL_ERROR` | Vérifiez l’état de la requête enregistrée et l’historique de la ressource avant de décider de réessayer une mutation. | | 502 | `INTERNAL_ERROR` | La génération ou la préparation de la miniature a échoué. Vérifiez l’état de la requête avant de décider de lancer une nouvelle génération. | | 503 | `ACTION_RESULT_UNAVAILABLE` | L’action a été exécutée, mais son résultat n’a pas pu être enregistré. Consultez l’état de la requête enregistrée et l’historique de la ressource avant de lancer une nouvelle génération. | | 503 | `INTERNAL_ERROR` | La génération de miniature ou son résultat enregistré est temporairement indisponible. Examinez l’état de la requête avant de réessayer. | | 503 | `SERVER_RESTARTING` | Le serveur redémarre. Réessayez dans un instant en conservant le même identifiant de requête pour une mutation. | ```json theme={null} { "code": "INSUFFICIENT_SCOPE", "message": "This credential does not permit the requested action.", "status": 403, "details": { "requiredScopes": ["thumbnails:write"] } } ``` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.