> ## 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.
# Cloner et enregistrer une voix
> Clonez et enregistrez une voix personnalisée à partir de 1 à 3 fichiers audio envoyés qui vous appartiennent. Une autorisation explicite est requise. Les échantillons doivent totaliser 10 à 120 secondes et peser au maximum 20 MB chacun. Les limites de voix du forfait s’appliquent.
Clonez et enregistrez une voix personnalisée à partir de 1 à 3 fichiers audio envoyés qui vous appartiennent. Une autorisation explicite est requise. Les échantillons doivent totaliser 10 à 120 secondes et peser au maximum 20 MB chacun. Les limites de voix du forfait s’appliquent.
```http theme={null}
POST https://api.voicecheap.ai/v1/actions/voices_clone
```
## 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: `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
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: 1. Longueur maximale: 80.
Liste de valeurs. Consultez le schéma d’entrée complet pour connaître la structure de ses éléments.
Nombre minimal d’éléments: 1. Nombre maximal d’éléments: 3.
Confirmez que vous avez l’autorisation de cloner la voix de la personne présente dans chaque échantillon.
Valeur requise: true.
Valeur booléenne.
Valeur par défaut: false.
Valeur textuelle.
Longueur maximale: 35. Motif: `^[a-z]{2,3}(-[A-Za-z0-9]{2,8})*$`.
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}$"
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 80
},
"samples": {
"minItems": 1,
"maxItems": 3,
"type": "array",
"items": {
"type": "object",
"properties": {
"fileKey": {
"type": "string",
"minLength": 1,
"maxLength": 1024,
"description": "An uploaded audio fileKey returned by voices_upload_complete for this account."
}
},
"required": ["fileKey"],
"additionalProperties": false
}
},
"hasPermission": {
"type": "boolean",
"const": true,
"description": "Confirm that you have permission to clone the person whose voice is in every sample."
},
"trimToMaxDuration": {
"default": false,
"type": "boolean"
},
"language": {
"type": "string",
"maxLength": 35,
"pattern": "^[a-z]{2,3}(-[A-Za-z0-9]{2,8})*$"
}
},
"required": ["name", "samples", "hasPermission"],
"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/voices_clone' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"requestId":"33333333-3333-4333-8333-333333333333","name":"Studio narrator","samples":[{"fileKey":"uploads/example-user/66666666-6666-4666-8666-666666666666-narrator.wav"}],"hasPermission":true,"trimToMaxDuration":false}'
```
```javascript JavaScript theme={null}
const input = {
requestId: '33333333-3333-4333-8333-333333333333',
name: 'Studio narrator',
samples: [
{
fileKey: 'uploads/example-user/66666666-6666-4666-8666-666666666666-narrator.wav',
},
],
hasPermission: true,
trimToMaxDuration: false,
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/voices_clone', {
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/voices_clone",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"requestId": "33333333-3333-4333-8333-333333333333", "name": "Studio narrator", "samples": [{"fileKey": "uploads/example-user/66666666-6666-4666-8666-666666666666-narrator.wav"}], "hasPermission": True, "trimToMaxDuration": False},
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.
La voix TTS personnalisée réutilisable enregistrée et le quota d’emplacements de voix enregistrées mis à jour.
```json HTTP 202 theme={null}
{
"data": {
"requestId": "33333333-3333-4333-8333-333333333333",
"status": "running",
"pollAction": "action_request_get",
"pollAfterSeconds": 5
},
"requestId": "33333333-3333-4333-8333-333333333333"
}
```
```json HTTP 200 theme={null}
{
"data": {
"voice": {
"accent": "original",
"id": "clone:33333333-3333-4333-8333-333333333333",
"name": "Studio narrator",
"previewUrl": "https://files.example.com/saved-narrator.mp3",
"source": "clone"
},
"cloneUsage": {
"canClone": true,
"limit": 10,
"remaining": 9,
"used": 1
}
},
"requestId": "33333333-3333-4333-8333-333333333333"
}
```
```json HTTP 202 replay_running theme={null}
{
"data": {
"requestId": "33333333-3333-4333-8333-333333333333",
"operation": "voices_clone",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "running",
"pollAfterSeconds": 5
},
"requestId": "33333333-3333-4333-8333-333333333333"
}
```
```json HTTP 200 replay_completed_without_result theme={null}
{
"data": {
"requestId": "33333333-3333-4333-8333-333333333333",
"operation": "voices_clone",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "completed",
"resultStored": false,
"message": "The action completed. Retrieve its output from the corresponding history or resource action."
},
"requestId": "33333333-3333-4333-8333-333333333333"
}
```
## Champs du résultat
| Champ | Description |
| - | - |
| `data.voice.id` | Identifiant de sélection de synthèse vocale réutilisable clone:\. Utilisez la valeur entière pour tts\_generate et uniquement l’UUID pour voices\_delete. |
| `data.voice.name` | Nom d’affichage de la voix enregistrée. |
| `data.voice.accent` | Les voix personnalisées enregistrées utilisent original. |
| `data.voice.source` | Les voix personnalisées enregistrées utilisent clone. |
| `data.voice.previewUrl` | URL temporaire d’aperçu audio de la voix enregistrée. |
| `data.cloneUsage.canClone` | Indique si le forfait actuel permet l’enregistrement de voix de synthèse vocale personnalisées ; consultez remaining pour connaître les emplacements disponibles. |
| `data.cloneUsage.limit` | Nombre maximal d’emplacements de voix TTS personnalisées enregistrées autorisé par l’offre. |
| `data.cloneUsage.used` | Emplacements de voix de synthèse vocale occupés, y compris les créations réservées. |
| `data.cloneUsage.remaining` | Emplacements disponibles pour les voix TTS enregistrées. |
## 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":"33333333-3333-4333-8333-333333333333","operation":"voices_clone"}'
```
```json HTTP 200 theme={null}
{
"data": {
"requestId": "33333333-3333-4333-8333-333333333333",
"operation": "voices_clone",
"status": "completed",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"resultStored": true,
"result": {
"voice": {
"accent": "original",
"id": "clone:33333333-3333-4333-8333-333333333333",
"name": "Studio narrator",
"previewUrl": "https://files.example.com/saved-narrator.mp3",
"source": "clone"
},
"cloneUsage": {
"canClone": true,
"limit": 10,
"remaining": 9,
"used": 1
}
}
}
}
```
## 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.
* Envoyez 1–3 échantillons audio appartenant au compte et utilisez leurs valeurs fileKey finalisées. Les formats d’échantillon pris en charge sont MP3, WAV, M4A, OGG et Opus ; chaque fichier doit être non vide et ne pas dépasser 20 MiB (20,971,520 octets). Les URL distantes et les envois d’autres comptes sont refusés.
* Les échantillons doivent totaliser au moins 10 secondes et au plus 120 secondes d’audio lisible. trimToMaxDuration vaut false par défaut ; définissez-le sur true pour raccourcir proportionnellement les échantillons totalisant plus de 120 secondes.
* hasPermission doit être le booléen JSON true, confirmant l’autorisation pour chaque échantillon. Une chaîne telle que "true" est rejetée.
* name doit contenir 1–80 caractères après suppression des espaces en début et en fin. Le champ facultatif language accepte un code de 2–3 lettres avec des sous-étiquettes facultatives, pour un maximum de 35 caractères.
* Cette action enregistre directement la voix clonée et occupe un emplacement de voix de synthèse vocale enregistrée. Elle ne consomme pas l’essai unique d’aperçu de clonage.
* Utilisez le voice.id renvoyé dans tts\_generate. Pour un clonage direct, son UUID est requestId ; voices\_delete accepte cet UUID sans le préfixe clone:.
* Le champ language accepté ne modifie pas le workflow de clonage avec enregistrement direct. Choisissez voices\_preview\_clone si vous avez besoin d’un script d’aperçu propre à une langue.
* 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. |
| 400 | `VOICE_CLONE_INVALID_AUDIO` | Un échantillon envoyé ne possède pas de durée audio lisible strictement positive. |
| 400 | `VOICE_CLONE_INVALID_FILE_SIZE` | Un échantillon enregistré est vide ou dépasse 20 MiB. |
| 400 | `VOICE_CLONE_INVALID_FILE_TYPE` | Un échantillon n’est pas un fichier audio MP3, WAV, M4A, OGG ou Opus. |
| 400 | `VOICE_CLONE_SAMPLE_TOO_LONG` | La durée cumulée des échantillons dépasse 120 secondes et le découpage n’a pas été activé. |
| 400 | `VOICE_CLONE_SAMPLE_TOO_SHORT` | Les échantillons réunis contiennent moins de 10 secondes d’audio. |
| 400 | `VOICE_SAMPLE_NOT_OWNED` | Une clé d’échantillon n’est pas sûre ou n’appartient pas au compte authentifié. |
| 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. |
| 403 | `VOICE_CLONING_REQUIRES_PAID_PLAN` | L’offre actuelle ne permet pas d’enregistrer des voix personnalisées de synthèse vocale. |
| 404 | `VOICE_CLONE_NOT_FOUND` | La requête de clonage n’appartient pas au compte authentifié ou n’est plus disponible. |
| 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_CLONE_IN_PROGRESS` | Un clone utilisant ce requestId est toujours en cours de création. |
| 409 | `VOICE_CLONE_LIMIT_REACHED` | Tous les emplacements de voix de synthèse vocale personnalisées enregistrées sont occupés. |
| 409 | `VOICE_CREATION_IN_PROGRESS` | Les modifications des voix sont bloquées pendant la suppression du 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. |
| 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. |
```json theme={null}
{
"code": "INSUFFICIENT_SCOPE",
"message": "This credential does not permit the requested action.",
"status": 403,
"details": {
"requiredScopes": ["voices:write"]
}
}
```
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.