> ## 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. # Aligner les mots de la voix > Préparez ou récupérez l’horodatage des mots d’une création vocale qui vous appartient. Renvoie ready, processing ou unavailable. L’alignement terminé est mis en cache. Préparez ou récupérez l’horodatage des mots d’une création vocale qui vous appartient. Renvoie ready, processing ou unavailable. L’alignement terminé est mis en cache. ```http theme={null} POST https://api.voicecheap.ai/v1/actions/tts_align ``` ## 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: `tts: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}$`. Identifiant d’historique renvoyé par tts\_generate ou tts\_list. Motif: `^(free-)?[0-9a-f]{64}$`. 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": { "description": "UUID v4 for this action. Reuse the same ID with identical arguments on retries.", "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}$" }, "historyId": { "type": "string", "pattern": "^(free-)?[0-9a-f]{64}$", "description": "History ID returned by tts_generate or tts_list." } }, "required": ["historyId"], "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/tts_align' \ --header "x-api-key: $VOICECHEAP_API_KEY" \ --header 'Content-Type: application/json' \ --data '{"requestId":"284a861a-4da8-4d67-ad48-8123e76c8e91","historyId":"722c80c6412edd4c3dcd625061e1c1feafbb0d54274d95fd8b5ca047f8cdd23d"}' ``` ```javascript JavaScript theme={null} const input = { requestId: '284a861a-4da8-4d67-ad48-8123e76c8e91', historyId: '722c80c6412edd4c3dcd625061e1c1feafbb0d54274d95fd8b5ca047f8cdd23d', }; const response = await fetch('https://api.voicecheap.ai/v1/actions/tts_align', { 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/tts_align", headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]}, json={"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91", "historyId": "722c80c6412edd4c3dcd625061e1c1feafbb0d54274d95fd8b5ca047f8cdd23d"}, 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. Statut de l’alignement et horodatages des mots de l’audio vocal appartenant à l’utilisateur. ```json HTTP 202 theme={null} { "data": { "requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91", "status": "running", "pollAction": "action_request_get", "pollAfterSeconds": 5 }, "requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91" } ``` ```json HTTP 200 theme={null} { "data": { "status": "ready", "wordAlignment": [ { "text": "Hello", "startSeconds": 0, "endSeconds": 0.6, "sourceStartCharacterIndex": 0, "sourceEndCharacterIndex": 5 }, { "text": "world.", "startSeconds": 0.7, "endSeconds": 1.4, "sourceStartCharacterIndex": 6, "sourceEndCharacterIndex": 12 } ] }, "requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91" } ``` ```json HTTP 202 replay_running theme={null} { "data": { "requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91", "operation": "tts_align", "createdAt": 1792144800000, "updatedAt": 1792144820000, "status": "running", "pollAfterSeconds": 5 }, "requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91" } ``` ```json HTTP 200 replay_completed_without_result theme={null} { "data": { "requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91", "operation": "tts_align", "createdAt": 1792144800000, "updatedAt": 1792144820000, "status": "completed", "resultStored": false, "message": "The action completed. Retrieve its output from the corresponding history or resource action." }, "requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91" } ``` ## Champs du résultat | Champ | Description | | - | - | | `data.status` | ready, processing ou unavailable. | | `data.wordAlignment` | Horodatages des mots, ou null lorsqu’aucun alignement n’est disponible. | | `data.wordAlignment[].text` | Texte du mot aligné. | | `data.wordAlignment[].startSeconds` | Début du mot en secondes. | | `data.wordAlignment[].endSeconds` | Fin du mot en secondes. | | `data.wordAlignment[].sourceStartCharacterIndex` | Index du caractère de début dans spokenText, après suppression des balises de contrôle de l’interprétation vocale. | | `data.wordAlignment[].sourceEndCharacterIndex` | Index du caractère de fin dans spokenText, après suppression des balises de contrôle de l’élocution. | ## 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":"284a861a-4da8-4d67-ad48-8123e76c8e91","operation":"tts_align"}' ``` ```json HTTP 200 theme={null} { "data": { "requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91", "operation": "tts_align", "status": "completed", "createdAt": 1792144800000, "updatedAt": 1792144820000, "resultStored": true, "result": { "status": "ready", "wordAlignment": [ { "text": "Hello", "startSeconds": 0, "endSeconds": 0.6, "sourceStartCharacterIndex": 0, "sourceEndCharacterIndex": 5 }, { "text": "world.", "startSeconds": 0.7, "endSeconds": 1.4, "sourceStartCharacterIndex": 6, "sourceEndCharacterIndex": 12 } ] } } } ``` ## Notes de l’opération * Utilisez un requestId UUID v4 pour cette mutation et réutilisez-le avec des arguments identiques lors des nouvelles tentatives. Les actions longues renvoient d’abord une requête running ; cet exemple est le résultat terminé du gestionnaire disponible via action\_request\_get. * status vaut ready avec des horodatages, processing lorsqu’un autre alignement est actif, ou unavailable lorsque l’alignement ne peut pas être produit actuellement. processing et unavailable renvoient wordAlignment: null. * Un alignement déjà réussi est mis en cache. Pour un aperçu de l’application, seule la portion audible du script est alignée ; compléter l’aperçu nécessite l’alignement du nouvel audio complet. * Les indices des caractères source font référence à spokenText après suppression des balises de contrôle d’interprétation prises en charge, tel que renvoyé par tts\_get. * Une requête d’action terminée ayant renvoyé processing conserve ce résultat enregistré lors d’une répétition idempotente. Utilisez tts\_get pour consulter les horodatages disponibles, ou lancez une nouvelle vérification d’alignement avec un nouveau requestId une fois l’alignement actif terminé. * L’historique de synthèse vocale et les voix personnalisées appartiennent au compte authentifié. La facturation d’équipe ne donne pas accès à la synthèse vocale ni aux voix d’un autre membre. ## 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` | Fournissez un UUID v4 dans requestId ou Idempotency-Key. | | 400 | `VALIDATION_ERROR` | L’entrée ne correspond pas au schéma de l’action ; examinez details pour connaître les erreurs de champs. | | 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. | | 404 | `TEXT_TO_SPEECH_HISTORY_NOT_FOUND` | L’élément d’historique de synthèse vocale n’existe pas ou appartient à un autre compte. | | 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` | Réutilisez un identifiant uniquement avec la même opération et les mêmes arguments. | | 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. | | 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. | | 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 | `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": ["tts:write"] } } ``` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.