curl --request POST 'https://api.voicecheap.ai/v1/actions/tts_generate' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"requestId":"284a861a-4da8-4d67-ad48-8123e76c8e91","text":"Hello world.","voice":"933563129e564b19a115bedd57b7406a","inputType":"text","instructionPreset":"narrator","instructions":"Speak clearly and leave a short pause at the end.","speed":1,"sourceFileName":"launch-script.txt"}'
const input = {
requestId: '284a861a-4da8-4d67-ad48-8123e76c8e91',
text: 'Hello world.',
voice: '933563129e564b19a115bedd57b7406a',
inputType: 'text',
instructionPreset: 'narrator',
instructions: 'Speak clearly and leave a short pause at the end.',
speed: 1,
sourceFileName: 'launch-script.txt',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/tts_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);
import os
import requests
response = requests.post(
"https://api.voicecheap.ai/v1/actions/tts_generate",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91", "text": "Hello world.", "voice": "933563129e564b19a115bedd57b7406a", "inputType": "text", "instructionPreset": "narrator", "instructions": "Speak clearly and leave a short pause at the end.", "speed": 1, "sourceFileName": "launch-script.txt"},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
{
"data": {
"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91",
"status": "running",
"pollAction": "action_request_get",
"pollAfterSeconds": 5
},
"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91"
}
{
"data": {
"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91",
"historyId": "722c80c6412edd4c3dcd625061e1c1feafbb0d54274d95fd8b5ca047f8cdd23d",
"status": "completed",
"characterCount": 12,
"previewEndIndex": null,
"downloadUrl": "https://files.example.com/launch-script-speech.mp3"
},
"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91"
}
{
"data": {
"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91",
"operation": "tts_generate",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "running",
"pollAfterSeconds": 5
},
"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91"
}
{
"data": {
"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91",
"operation": "tts_generate",
"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"
}
Synthèse vocale
Générer un audio vocal
Créez de la parole à partir de texte avec une voix du catalogue ou une voix personnalisée qui vous appartient. Les mêmes crédits de caractères et limites de forfait que dans l’application s’appliquent. Renvoie un identifiant d’historique et une URL temporaire de téléchargement audio. Réutilisez requestId pour éviter une seconde génération.
POST
/
v1
/
actions
/
tts_generate
curl --request POST 'https://api.voicecheap.ai/v1/actions/tts_generate' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"requestId":"284a861a-4da8-4d67-ad48-8123e76c8e91","text":"Hello world.","voice":"933563129e564b19a115bedd57b7406a","inputType":"text","instructionPreset":"narrator","instructions":"Speak clearly and leave a short pause at the end.","speed":1,"sourceFileName":"launch-script.txt"}'
const input = {
requestId: '284a861a-4da8-4d67-ad48-8123e76c8e91',
text: 'Hello world.',
voice: '933563129e564b19a115bedd57b7406a',
inputType: 'text',
instructionPreset: 'narrator',
instructions: 'Speak clearly and leave a short pause at the end.',
speed: 1,
sourceFileName: 'launch-script.txt',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/tts_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);
import os
import requests
response = requests.post(
"https://api.voicecheap.ai/v1/actions/tts_generate",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91", "text": "Hello world.", "voice": "933563129e564b19a115bedd57b7406a", "inputType": "text", "instructionPreset": "narrator", "instructions": "Speak clearly and leave a short pause at the end.", "speed": 1, "sourceFileName": "launch-script.txt"},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
{
"data": {
"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91",
"status": "running",
"pollAction": "action_request_get",
"pollAfterSeconds": 5
},
"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91"
}
{
"data": {
"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91",
"historyId": "722c80c6412edd4c3dcd625061e1c1feafbb0d54274d95fd8b5ca047f8cdd23d",
"status": "completed",
"characterCount": 12,
"previewEndIndex": null,
"downloadUrl": "https://files.example.com/launch-script-speech.mp3"
},
"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91"
}
{
"data": {
"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91",
"operation": "tts_generate",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "running",
"pollAfterSeconds": 5
},
"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91"
}
{
"data": {
"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91",
"operation": "tts_generate",
"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"
}
Créez de la parole à partir de texte avec une voix du catalogue ou une voix personnalisée qui vous appartient. Les mêmes crédits de caractères et limites de forfait que dans l’application s’appliquent. Renvoie un identifiant d’historique et une URL temporaire de téléchargement audio. Réutilisez requestId pour éviter une seconde génération.
Autorisations requises:
POST https://api.voicecheap.ai/v1/actions/tts_generate
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.
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
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
Valeur textuelle.Longueur minimale: 1. Longueur maximale: 128000.
string
requis
Identifiant de sélection de voix issu de voices_list, y compris les identifiants clone: des voix personnalisées enregistrées.Longueur minimale: 1. Longueur maximale: 255.
string
Valeur textuelle.Valeurs acceptées: “text”, “pdf”. Valeur par défaut: “text”.
string
Valeur textuelle.Valeurs acceptées: “default”, “cheerful”, “calm”, “narrator”, “dramatic”, “whisper”, “energetic”. Valeur par défaut: “default”.
string
Valeur textuelle.Longueur maximale: 300.
number
Valeur numérique.Minimum: 0.5. Maximum: 2. Valeur par défaut: 1.
string
Valeur textuelle.Longueur maximale: 255.
Schéma d’entrée complet
Schéma d’entrée complet
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.
{
"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}$"
},
"text": {
"type": "string",
"minLength": 1,
"maxLength": 128000
},
"voice": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"description": "A voice selection ID from voices_list, including clone: IDs for saved custom voices."
},
"inputType": {
"default": "text",
"type": "string",
"enum": ["text", "pdf"]
},
"instructionPreset": {
"default": "default",
"type": "string",
"enum": ["default", "cheerful", "calm", "narrator", "dramatic", "whisper", "energetic"]
},
"instructions": {
"type": "string",
"maxLength": 300
},
"speed": {
"default": 1,
"type": "number",
"minimum": 0.5,
"maximum": 2
},
"sourceFileName": {
"type": "string",
"maxLength": 255
}
},
"required": ["text", "voice"],
"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.curl --request POST 'https://api.voicecheap.ai/v1/actions/tts_generate' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"requestId":"284a861a-4da8-4d67-ad48-8123e76c8e91","text":"Hello world.","voice":"933563129e564b19a115bedd57b7406a","inputType":"text","instructionPreset":"narrator","instructions":"Speak clearly and leave a short pause at the end.","speed":1,"sourceFileName":"launch-script.txt"}'
const input = {
requestId: '284a861a-4da8-4d67-ad48-8123e76c8e91',
text: 'Hello world.',
voice: '933563129e564b19a115bedd57b7406a',
inputType: 'text',
instructionPreset: 'narrator',
instructions: 'Speak clearly and leave a short pause at the end.',
speed: 1,
sourceFileName: 'launch-script.txt',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/tts_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);
import os
import requests
response = requests.post(
"https://api.voicecheap.ai/v1/actions/tts_generate",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91", "text": "Hello world.", "voice": "933563129e564b19a115bedd57b7406a", "inputType": "text", "instructionPreset": "narrator", "instructions": "Speak clearly and leave a short pause at the end.", "speed": 1, "sourceFileName": "launch-script.txt"},
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 de la génération de parole terminée et URL temporaire de téléchargement du MP3. Le gestionnaire ne renvoie pas d’octets audio.{
"data": {
"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91",
"status": "running",
"pollAction": "action_request_get",
"pollAfterSeconds": 5
},
"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91"
}
{
"data": {
"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91",
"historyId": "722c80c6412edd4c3dcd625061e1c1feafbb0d54274d95fd8b5ca047f8cdd23d",
"status": "completed",
"characterCount": 12,
"previewEndIndex": null,
"downloadUrl": "https://files.example.com/launch-script-speech.mp3"
},
"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91"
}
{
"data": {
"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91",
"operation": "tts_generate",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "running",
"pollAfterSeconds": 5
},
"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91"
}
{
"data": {
"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91",
"operation": "tts_generate",
"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.requestId | UUID v4 fourni pour l’action de génération. |
data.historyId | ID d’historique de synthèse vocale vous appartenant : 64 caractères hexadécimaux minuscules, avec éventuellement le préfixe free- pour un aperçu de l’application. |
data.status | completed lorsque le résultat de synthèse vocale est prêt. |
data.characterCount | Nombre de caractères du texte d’entrée complet après suppression des espaces en début et en fin. |
data.previewEndIndex | Limite en caractères de l’aperçu audio partiel, ou null pour un audio complet. La génération payante via l’intégration renvoie un audio complet. |
data.downloadUrl | URL temporaire de téléchargement MP3. Demandez-en une nouvelle via tts_download. |
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.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_generate"}'
HTTP 200
{
"data": {
"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91",
"operation": "tts_generate",
"status": "completed",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"resultStored": true,
"result": {
"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91",
"historyId": "722c80c6412edd4c3dcd625061e1c1feafbb0d54274d95fd8b5ca047f8cdd23d",
"status": "completed",
"characterCount": 12,
"previewEndIndex": null,
"downloadUrl": "https://files.example.com/launch-script-speech.mp3"
}
}
}
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.
- Choisissez voice dans voices_list. Les ID de voix de doublage de dubbing_voices_list appartiennent à une bibliothèque distincte.
- Les espaces en début et en fin du texte sont supprimés. Le schéma accepte au plus 128,000 caractères ; les offres Beginner et Starter actuelles autorisent 64,000 caractères par génération, contre 128,000 pour Creator et les offres supérieures. L’offre actuelle et les crédits de caractères TTS disponibles sont vérifiés de nouveau avant la génération.
- inputType vaut text par défaut et peut être text ou pdf. Même avec pdf, fournissez le texte extrait dans text ; cette action n’accepte pas l’envoi d’un PDF ni une URL de PDF.
- instructionPreset vaut default par défaut et accepte default, cheerful, calm, narrator, dramatic, whisper et energetic. instructions est facultatif et limité à 300 caractères après suppression des espaces en début et en fin. speed vaut 1 par défaut et varie de 0.5 à 2.
- sourceFileName est une métadonnée facultative, limitée à 255 caractères après suppression des espaces en début et en fin, qui détermine le nom du fichier téléchargé.
- Une requête répétée réussie restitue l’audio enregistré sans le générer ni le facturer à nouveau. Les URL sont temporaires ; utilisez tts_download pour obtenir un nouveau téléchargement.
- 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 | INVALID_VOICE | La sélection de voix est invalide, n’appartient pas à ce compte ou n’est pas prête. |
| 400 | TEXT_REQUIRED | Le script est vide après suppression des balises de contrôle de l’interprétation vocale. |
| 400 | TEXT_TOO_LONG | Le script dépasse la limite de caractères par génération de l’offre actuelle. |
| 400 | VALIDATION_ERROR | L’entrée ne correspond pas au schéma de l’action ; examinez details pour connaître les erreurs de champs. |
| 400 | VOICE_UNAVAILABLE | La voix du catalogue sélectionnée n’est plus disponible ; choisissez un identifiant renvoyé par voices_list. |
| 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 | PAID_PLAN_REQUIRED | Le compte actuel ne dispose plus d’une offre payante pour la génération vocale via l’intégration. |
| 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 | Réutilisez un identifiant uniquement avec la même opération et les mêmes arguments. |
| 409 | TEXT_TO_SPEECH_GENERATION_IN_PROGRESS | Une requête vocale identique est toujours en cours de traitement. |
| 409 | TEXT_TO_SPEECH_REQUEST_CONFLICT | Ce requestId a déjà été utilisé avec une entrée de synthèse vocale différente. |
| 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 | TEXT_TO_SPEECH_CHARACTER_LIMIT_REACHED | Le script dépasse le total des caractères TTS inclus et achetés disponibles. |
| 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 | L’action n’a pas pu être finalisée ou son résultat n’a pas pu être confirmé. Vérifiez le statut de la requête et l’historique de la ressource avant de lancer une autre 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 | SERVER_RESTARTING | Le serveur redémarre. Réessayez dans un instant en conservant le même identifiant de requête pour une mutation. |
{
"code": "INSUFFICIENT_SCOPE",
"message": "This credential does not permit the requested action.",
"status": 403,
"details": {
"requiredScopes": ["tts:write"]
}
}
Cette page vous a-t-elle été utile ?

