curl --request POST 'https://api.voicecheap.ai/v1/actions/tts_get' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"historyId":"722c80c6412edd4c3dcd625061e1c1feafbb0d54274d95fd8b5ca047f8cdd23d"}'
const input = {
historyId: '722c80c6412edd4c3dcd625061e1c1feafbb0d54274d95fd8b5ca047f8cdd23d',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/tts_get', {
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_get",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"historyId": "722c80c6412edd4c3dcd625061e1c1feafbb0d54274d95fd8b5ca047f8cdd23d"},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
{
"data": {
"historyId": "722c80c6412edd4c3dcd625061e1c1feafbb0d54274d95fd8b5ca047f8cdd23d",
"text": "Hello world.",
"spokenText": "Hello world.",
"voice": "933563129e564b19a115bedd57b7406a",
"voiceName": "Sarah",
"voiceSource": "catalog",
"inputType": "text",
"instructionPreset": "narrator",
"instructions": "Speak clearly and leave a short pause at the end.",
"speed": 1,
"sourceFileName": "launch-script.txt",
"characterCount": 12,
"durationSeconds": 1.5,
"previewEndIndex": null,
"createdAt": 1792152000000,
"updatedAt": 1792152000000,
"status": "success",
"audioUrl": "https://files.example.com/launch-script.mp3",
"wordAlignment": [
{
"text": "Hello",
"startSeconds": 0,
"endSeconds": 0.6,
"sourceStartCharacterIndex": 0,
"sourceEndCharacterIndex": 5
},
{
"text": "world.",
"startSeconds": 0.7,
"endSeconds": 1.4,
"sourceStartCharacterIndex": 6,
"sourceEndCharacterIndex": 12
}
]
}
}
Synthèse vocale
Consulter un audio vocal généré
Consultez une création vocale qui vous appartient, avec son script, ses paramètres d’interprétation, son URL audio temporaire et l’alignement des mots disponible.
POST
/
v1
/
actions
/
tts_get
curl --request POST 'https://api.voicecheap.ai/v1/actions/tts_get' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"historyId":"722c80c6412edd4c3dcd625061e1c1feafbb0d54274d95fd8b5ca047f8cdd23d"}'
const input = {
historyId: '722c80c6412edd4c3dcd625061e1c1feafbb0d54274d95fd8b5ca047f8cdd23d',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/tts_get', {
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_get",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"historyId": "722c80c6412edd4c3dcd625061e1c1feafbb0d54274d95fd8b5ca047f8cdd23d"},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
{
"data": {
"historyId": "722c80c6412edd4c3dcd625061e1c1feafbb0d54274d95fd8b5ca047f8cdd23d",
"text": "Hello world.",
"spokenText": "Hello world.",
"voice": "933563129e564b19a115bedd57b7406a",
"voiceName": "Sarah",
"voiceSource": "catalog",
"inputType": "text",
"instructionPreset": "narrator",
"instructions": "Speak clearly and leave a short pause at the end.",
"speed": 1,
"sourceFileName": "launch-script.txt",
"characterCount": 12,
"durationSeconds": 1.5,
"previewEndIndex": null,
"createdAt": 1792152000000,
"updatedAt": 1792152000000,
"status": "success",
"audioUrl": "https://files.example.com/launch-script.mp3",
"wordAlignment": [
{
"text": "Hello",
"startSeconds": 0,
"endSeconds": 0.6,
"sourceStartCharacterIndex": 0,
"sourceEndCharacterIndex": 5
},
{
"text": "world.",
"startSeconds": 0.7,
"endSeconds": 1.4,
"sourceStartCharacterIndex": 6,
"sourceEndCharacterIndex": 12
}
]
}
}
Consultez une création vocale qui vous appartient, avec son script, ses paramètres d’interprétation, son URL audio temporaire et l’alignement des mots disponible.
Autorisations requises:
POST https://api.voicecheap.ai/v1/actions/tts_get
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:read.
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
requis
Identifiant d’historique renvoyé par tts_generate ou tts_list.Motif:
^(free-)?[0-9a-f]{64}$.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": {
"historyId": {
"type": "string",
"pattern": "^(free-)?[0-9a-f]{64}$",
"description": "History ID returned by tts_generate or tts_list."
}
},
"required": ["historyId"],
"additionalProperties": false
}
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_get' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"historyId":"722c80c6412edd4c3dcd625061e1c1feafbb0d54274d95fd8b5ca047f8cdd23d"}'
const input = {
historyId: '722c80c6412edd4c3dcd625061e1c1feafbb0d54274d95fd8b5ca047f8cdd23d',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/tts_get', {
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_get",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"historyId": "722c80c6412edd4c3dcd625061e1c1feafbb0d54274d95fd8b5ca047f8cdd23d"},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
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. Détail de l’historique de synthèse vocale appartenant à l’acteur, versions complètes du script modifiable et du script parlé, paramètres d’interprétation vocale, URL de lecture temporaire et horodatages des mots disponibles.{
"data": {
"historyId": "722c80c6412edd4c3dcd625061e1c1feafbb0d54274d95fd8b5ca047f8cdd23d",
"text": "Hello world.",
"spokenText": "Hello world.",
"voice": "933563129e564b19a115bedd57b7406a",
"voiceName": "Sarah",
"voiceSource": "catalog",
"inputType": "text",
"instructionPreset": "narrator",
"instructions": "Speak clearly and leave a short pause at the end.",
"speed": 1,
"sourceFileName": "launch-script.txt",
"characterCount": 12,
"durationSeconds": 1.5,
"previewEndIndex": null,
"createdAt": 1792152000000,
"updatedAt": 1792152000000,
"status": "success",
"audioUrl": "https://files.example.com/launch-script.mp3",
"wordAlignment": [
{
"text": "Hello",
"startSeconds": 0,
"endSeconds": 0.6,
"sourceStartCharacterIndex": 0,
"sourceEndCharacterIndex": 5
},
{
"text": "world.",
"startSeconds": 0.7,
"endSeconds": 1.4,
"sourceStartCharacterIndex": 6,
"sourceEndCharacterIndex": 12
}
]
}
}
Champs du résultat
| Champ | Description |
|---|---|
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.voice | L’ID de sélection TTS d’origine, y compris clone:<UUID> pour une voix personnalisée enregistrée. |
data.voiceName | Nom d’affichage enregistré facultatif de la voix sélectionnée. |
data.voiceSource | Source facultative de la voix : catalog ou clone. |
data.inputType | Type d’entrée d’origine : text ou pdf. |
data.instructionPreset | Préréglage d’élocution enregistré. |
data.sourceFileName | Nom de fichier original facultatif fourni lors de la génération. |
data.characterCount | Nombre de caractères enregistré pour cette création de synthèse vocale. |
data.durationSeconds | Durée de l’audio en secondes. |
data.createdAt | Date de création sous forme d’horodatage Unix en millisecondes. |
data.updatedAt | Date de dernière modification sous forme d’horodatage Unix en millisecondes. |
data.status | Les créations vocales réussies enregistrées utilisent success ; tts_generate utilise completed dans son résultat de génération. |
data.text | Script complet enregistré et modifiable, y compris les balises de contrôle de l’interprétation prises en charge. |
data.spokenText | Script enregistré dont les balises de contrôle de l’interprétation prises en charge ont été retirées. |
data.instructions | Instructions d’interprétation personnalisées enregistrées ; vides si elles sont absentes. |
data.speed | Vitesse de lecture vocale enregistrée ; 1 si elle est absente des anciens enregistrements. |
data.previewEndIndex | Limite en caractères de l’aperçu disponible, ou null pour un audio complet. |
data.audioUrl | URL audio temporaire permettant l’écoute. |
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. |
Notes de l’opération
- historyId doit comporter 64 caractères hexadécimaux minuscules, éventuellement précédés de free-. Utilisez l’identifiant renvoyé par tts_generate ou tts_list.
- Les propriétés facultatives d’anciens enregistrements, telles que voiceName, voiceSource et sourceFileName, peuvent être omises. Si elles sont absentes, instructions vaut une chaîne vide, speed vaut 1 et previewEndIndex vaut null.
- wordAlignment peut valoir null. Cette lecture charge l’alignement existant ; utilisez tts_align pour préparer les horodatages.
- Les index de caractères sources dans wordAlignment font référence à spokenText, dont les balises de contrôle de l’interprétation vocale ont été supprimées.
- audioUrl est temporaire. Appelez de nouveau tts_get pour actualiser la lecture ou tts_download pour obtenir un lien de 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 | 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 | 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. |
| 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 | 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:read"]
}
}
Cette page vous a-t-elle été utile ?

