curl --request POST 'https://api.voicecheap.ai/v1/actions/voices_design' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"requestId":"284a861a-4da8-4d67-ad48-8123e76c8e91","name":"Studio narrator","description":"A warm, clear English narrator with steady pacing and a natural conversational delivery.","language":"en"}'
const input = {
requestId: '284a861a-4da8-4d67-ad48-8123e76c8e91',
name: 'Studio narrator',
description: 'A warm, clear English narrator with steady pacing and a natural conversational delivery.',
language: 'en',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/voices_design', {
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/voices_design",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91", "name": "Studio narrator", "description": "A warm, clear English narrator with steady pacing and a natural conversational delivery.", "language": "en"},
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": {
"voicePreviews": [
{
"id": "44444444-4444-4444-8444-444444444444",
"kind": "design",
"name": "Studio narrator 1",
"previewUrl": "https://files.example.com/designed-narrator-1.wav",
"expiresAt": 1792238400000,
"durationSeconds": 8
},
{
"id": "55555555-5555-4555-8555-555555555555",
"kind": "design",
"name": "Studio narrator 2",
"previewUrl": "https://files.example.com/designed-narrator-2.wav",
"expiresAt": 1792238400000,
"durationSeconds": 9
}
],
"creationUsage": {
"cloneTrial": {
"limit": 1,
"used": 0,
"remaining": 1
},
"design": {
"limit": 5,
"used": 1,
"remaining": 4,
"resetsAt": 1792195200000
},
"previewExpiresAfterHours": 24
}
},
"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91"
}
{
"data": {
"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91",
"operation": "voices_design",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "running",
"pollAfterSeconds": 5
},
"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91"
}
{
"data": {
"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91",
"operation": "voices_design",
"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"
}
Voix de synthèse
Concevoir une voix
Créez des propositions de voix à partir d’une description en utilisant votre quota de conception vocale. Écoutez-les avec voices_preview_get, puis enregistrez l’aperçu choisi.
POST
/
v1
/
actions
/
voices_design
curl --request POST 'https://api.voicecheap.ai/v1/actions/voices_design' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"requestId":"284a861a-4da8-4d67-ad48-8123e76c8e91","name":"Studio narrator","description":"A warm, clear English narrator with steady pacing and a natural conversational delivery.","language":"en"}'
const input = {
requestId: '284a861a-4da8-4d67-ad48-8123e76c8e91',
name: 'Studio narrator',
description: 'A warm, clear English narrator with steady pacing and a natural conversational delivery.',
language: 'en',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/voices_design', {
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/voices_design",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91", "name": "Studio narrator", "description": "A warm, clear English narrator with steady pacing and a natural conversational delivery.", "language": "en"},
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": {
"voicePreviews": [
{
"id": "44444444-4444-4444-8444-444444444444",
"kind": "design",
"name": "Studio narrator 1",
"previewUrl": "https://files.example.com/designed-narrator-1.wav",
"expiresAt": 1792238400000,
"durationSeconds": 8
},
{
"id": "55555555-5555-4555-8555-555555555555",
"kind": "design",
"name": "Studio narrator 2",
"previewUrl": "https://files.example.com/designed-narrator-2.wav",
"expiresAt": 1792238400000,
"durationSeconds": 9
}
],
"creationUsage": {
"cloneTrial": {
"limit": 1,
"used": 0,
"remaining": 1
},
"design": {
"limit": 5,
"used": 1,
"remaining": 4,
"resetsAt": 1792195200000
},
"previewExpiresAfterHours": 24
}
},
"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91"
}
{
"data": {
"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91",
"operation": "voices_design",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "running",
"pollAfterSeconds": 5
},
"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91"
}
{
"data": {
"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91",
"operation": "voices_design",
"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 des propositions de voix à partir d’une description en utilisant votre quota de conception vocale. Écoutez-les avec voices_preview_get, puis enregistrez l’aperçu choisi.
Autorisations requises:
POST https://api.voicecheap.ai/v1/actions/voices_design
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.
voices: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: 80.
string
requis
Valeur textuelle.Longueur minimale: 1. Longueur maximale: 2000.
string
Valeur textuelle.Longueur maximale: 35. Motif:
^[a-z]{2,3}(-[A-Za-z0-9]{2,8})*$.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}$"
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 80
},
"description": {
"type": "string",
"minLength": 1,
"maxLength": 2000
},
"language": {
"type": "string",
"maxLength": 35,
"pattern": "^[a-z]{2,3}(-[A-Za-z0-9]{2,8})*$"
}
},
"required": ["name", "description"],
"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/voices_design' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"requestId":"284a861a-4da8-4d67-ad48-8123e76c8e91","name":"Studio narrator","description":"A warm, clear English narrator with steady pacing and a natural conversational delivery.","language":"en"}'
const input = {
requestId: '284a861a-4da8-4d67-ad48-8123e76c8e91',
name: 'Studio narrator',
description: 'A warm, clear English narrator with steady pacing and a natural conversational delivery.',
language: 'en',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/voices_design', {
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/voices_design",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91", "name": "Studio narrator", "description": "A warm, clear English narrator with steady pacing and a natural conversational delivery.", "language": "en"},
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. Tous les aperçus actifs non enregistrés et les quotas de création actualisés, dont deux nouveaux candidats de voix conçues.{
"data": {
"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91",
"status": "running",
"pollAction": "action_request_get",
"pollAfterSeconds": 5
},
"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91"
}
{
"data": {
"voicePreviews": [
{
"id": "44444444-4444-4444-8444-444444444444",
"kind": "design",
"name": "Studio narrator 1",
"previewUrl": "https://files.example.com/designed-narrator-1.wav",
"expiresAt": 1792238400000,
"durationSeconds": 8
},
{
"id": "55555555-5555-4555-8555-555555555555",
"kind": "design",
"name": "Studio narrator 2",
"previewUrl": "https://files.example.com/designed-narrator-2.wav",
"expiresAt": 1792238400000,
"durationSeconds": 9
}
],
"creationUsage": {
"cloneTrial": {
"limit": 1,
"used": 0,
"remaining": 1
},
"design": {
"limit": 5,
"used": 1,
"remaining": 4,
"resetsAt": 1792195200000
},
"previewExpiresAfterHours": 24
}
},
"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91"
}
{
"data": {
"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91",
"operation": "voices_design",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "running",
"pollAfterSeconds": 5
},
"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91"
}
{
"data": {
"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91",
"operation": "voices_design",
"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.voicePreviews | Tous les aperçus actuellement actifs et non enregistrés de ce compte, y compris les candidats issus de requêtes antérieures. |
data.voicePreviews[].id | UUID v4 de l’aperçu utilisé par voices_preview_get et voices_save_preview. |
data.voicePreviews[].kind | clone ou design. |
data.voicePreviews[].name | Nom d’affichage de l’aperçu ; les candidats de voix conçues ajoutent un numéro au nom demandé. |
data.voicePreviews[].previewUrl | URL audio temporaire permettant la lecture. Demandez une nouvelle URL avec voices_preview_get tant que l’aperçu reste actif. |
data.voicePreviews[].expiresAt | Expiration de l’aperçu sous forme d’horodatage Unix en millisecondes. |
data.voicePreviews[].durationSeconds | Durée de l’aperçu audio en secondes. |
data.creationUsage.cloneTrial | Quota d’essai d’aperçu de clonage valable à vie, avec limit, used et remaining. |
data.creationUsage.design | Quota quotidien de conception de voix avec limit, used, remaining et resetsAt en millisecondes Unix. |
data.creationUsage.previewExpiresAfterHours | Durée de vie d’un aperçu non enregistré, en heures, actuellement 24. |
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":"voices_design"}'
HTTP 200
{
"data": {
"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91",
"operation": "voices_design",
"status": "completed",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"resultStored": true,
"result": {
"voicePreviews": [
{
"id": "44444444-4444-4444-8444-444444444444",
"kind": "design",
"name": "Studio narrator 1",
"previewUrl": "https://files.example.com/designed-narrator-1.wav",
"expiresAt": 1792238400000,
"durationSeconds": 8
},
{
"id": "55555555-5555-4555-8555-555555555555",
"kind": "design",
"name": "Studio narrator 2",
"previewUrl": "https://files.example.com/designed-narrator-2.wav",
"expiresAt": 1792238400000,
"durationSeconds": 9
}
],
"creationUsage": {
"cloneTrial": {
"limit": 1,
"used": 0,
"remaining": 1
},
"design": {
"limit": 5,
"used": 1,
"remaining": 4,
"resetsAt": 1792195200000
},
"previewExpiresAfterHours": 24
}
}
}
}
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.
- name contient 1–80 caractères après suppression des espaces en début et en fin. description contient 1–2,000 caractères après cette même suppression. Le champ facultatif language accepte un code de 2–3 lettres avec des sous-étiquettes facultatives, dans la limite de 35 caractères.
- Une requête de conception réussie crée deux candidats kind: design avec des noms numérotés et consomme une requête de conception quotidienne. Les offres payantes autorisent cinq requêtes par jour UTC ; consultez creationUsage.design pour connaître le nombre actuel et la date de réinitialisation.
- Les candidats sont conservés pendant 24 heures et ne sont pas des voix de synthèse vocale enregistrées réutilisables. Écoutez-les avec voices_preview_get, puis enregistrez le candidat choisi avec voices_save_preview.
- La réponse inclut les aperçus actifs précédents ainsi que les nouveaux candidats. Aucun emplacement de voix enregistrée n’est occupé tant qu’un candidat n’est pas enregistré.
- 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 | USER_NOT_FOUND | Le compte authentifié n’existe plus. |
| 404 | VOICE_PREVIEW_NOT_FOUND | La requête 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. |
| 409 | VOICE_CREATION_IN_PROGRESS | L’aperçu est toujours en cours de création ou la suppression du compte bloque les nouvelles opérations sur les voix. |
| 409 | VOICE_CREATION_REQUEST_MISMATCH | Ce requestId a été utilisé pour un autre type de voix, d’autres paramètres ou d’autres échantillons. |
| 409 | VOICE_DESIGN_LIMIT_REACHED | Le quota quotidien de création de voix est épuisé. |
| 410 | VOICE_PREVIEW_EXPIRED | L’aperçu de voix de la requête a expiré ou n’est plus disponible. |
| 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. |
| 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": ["voices:write"]
}
}
Cette page vous a-t-elle été utile ?

