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}'
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);
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)
{
"data": {
"requestId": "33333333-3333-4333-8333-333333333333",
"status": "running",
"pollAction": "action_request_get",
"pollAfterSeconds": 5
},
"requestId": "33333333-3333-4333-8333-333333333333"
}
{
"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"
}
{
"data": {
"requestId": "33333333-3333-4333-8333-333333333333",
"operation": "voices_clone",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "running",
"pollAfterSeconds": 5
},
"requestId": "33333333-3333-4333-8333-333333333333"
}
{
"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"
}
Voces de texto a voz
Clonar y guardar una voz
Clona y guarda una voz personalizada a partir de 1–3 archivos de audio cargados de tu propiedad. Se requiere permiso explícito. Las muestras deben sumar entre 10 y 120 segundos y cada una debe ocupar como máximo 20 MB. Se aplican los límites de voces del plan.
POST
/
v1
/
actions
/
voices_clone
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}'
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);
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)
{
"data": {
"requestId": "33333333-3333-4333-8333-333333333333",
"status": "running",
"pollAction": "action_request_get",
"pollAfterSeconds": 5
},
"requestId": "33333333-3333-4333-8333-333333333333"
}
{
"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"
}
{
"data": {
"requestId": "33333333-3333-4333-8333-333333333333",
"operation": "voices_clone",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "running",
"pollAfterSeconds": 5
},
"requestId": "33333333-3333-4333-8333-333333333333"
}
{
"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"
}
Clona y guarda una voz personalizada a partir de 1–3 archivos de audio cargados de tu propiedad. Se requiere permiso explícito. Las muestras deben sumar entre 10 y 120 segundos y cada una debe ocupar como máximo 20 MB. Se aplican los límites de voces del plan.
Permisos necesarios:
POST https://api.voicecheap.ai/v1/actions/voices_clone
Autenticación y permisos
string
requerido
Envía una clave de API de VoiceCheap en esta cabecera. También se admite Authorization: Bearer con la misma clave de API. Los tokens de acceso OAuth
solo se aceptan en MCP, no en este endpoint REST.
voices:write.
Se requiere una suscripción de pago activa. Los permisos no cambian los roles del equipo, la propiedad de los recursos, los créditos multimedia ni los límites del plan.
Parámetros
string
Opcional en la capa de transporte: el servidor introduce un identificador antes de la validación si se omite. Proporciona tu propio UUID v4 estable para recuperar la solicitud de forma segura si se pierde la respuesta.Formato: “uuid”. Patrón:
^[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
requerido
Valor de texto.Longitud mínima: 1. Longitud máxima: 80.
array
requerido
Lista de valores. Consulta la estructura de sus elementos en el esquema completo de entrada.Número mínimo de elementos: 1. Número máximo de elementos: 3.
boolean
requerido
Confirma que tienes permiso para clonar a la persona cuya voz aparece en cada muestra.Valor obligatorio: true.
boolean
Valor booleano.Valor predeterminado: false.
string
Valor de texto.Longitud máxima: 35. Patrón:
^[a-z]{2,3}(-[A-Za-z0-9]{2,8})*$.Esquema completo de entrada
Esquema completo de entrada
El JSON Schema siguiente conserva los nombres exactos de los campos, los tipos anidados, los valores predeterminados, los límites y los valores aceptados que expone el descubrimiento. Las reglas adicionales entre campos se indican en las notas de la operación.
{
"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
}
Idempotencia
Usa un UUID v4 en requestId o en la cabecera HTTP Idempotency-Key para cada modificación. Reutiliza el mismo identificador y argumentos idénticos después de un fallo de red. Si proporcionas ambos, deben coincidir. Repetir una solicitud guardada no vuelve a ejecutar la operación ni consume otra llamada mensual. Las solicitudes fallidas o interrumpidas no se reinician automáticamente. Toda modificación puede devolver HTTP 202 cuando un reintento encuentra la misma solicitud todavía en ejecución, incluso si su primera ejecución suele ser síncrona. Si la ejecución ha terminado pero resultStored es false, un reintento devuelve HTTP 200 con el estado de la solicitud guardada en lugar del resultado original. Recupera la salida mediante la acción de historial, resultado o descarga de su ámbito.Ejemplos de solicitud
Sustituye los identificadores de recursos y las claves multimedia de los ejemplos por valores devueltos para tu cuenta. Mantén el identificador de solicitud al reintentar la misma modificación.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}'
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);
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)
Respuesta
Esta operación devuelve HTTP 202 mientras se ejecuta. Guarda requestId y consulta action_request_get con ese identificador y el nombre de la operación original. Los estados de consulta son running, completed, failed e interrupted. Un resultado completado puede apuntar a un trabajo multimedia independiente; continúa con la acción de estado o de salida específica de la operación. La voz TTS personalizada guardada y reutilizable y el límite actualizado de plazas para voces guardadas.{
"data": {
"requestId": "33333333-3333-4333-8333-333333333333",
"status": "running",
"pollAction": "action_request_get",
"pollAfterSeconds": 5
},
"requestId": "33333333-3333-4333-8333-333333333333"
}
{
"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"
}
{
"data": {
"requestId": "33333333-3333-4333-8333-333333333333",
"operation": "voices_clone",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "running",
"pollAfterSeconds": 5
},
"requestId": "33333333-3333-4333-8333-333333333333"
}
{
"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"
}
Campos del resultado
| Campo | Descripción |
|---|---|
data.voice.id | ID de selección TTS reutilizable clone:<UUID>. Usa el valor completo para tts_generate y solo el UUID para voices_delete. |
data.voice.name | Nombre para mostrar de la voz guardada. |
data.voice.accent | Las voces personalizadas guardadas usan original. |
data.voice.source | Las voces personalizadas guardadas usan clone. |
data.voice.previewUrl | URL temporal de vista previa de audio de la voz guardada. |
data.cloneUsage.canClone | Indica si el plan actual permite voces TTS personalizadas guardadas; consulta remaining para ver los espacios disponibles. |
data.cloneUsage.limit | Límite del plan para las plazas de voces TTS personalizadas guardadas. |
data.cloneUsage.used | Espacios de voces TTS ocupados, incluidas las creaciones reservadas. |
data.cloneUsage.remaining | Plazas disponibles para voces TTS guardadas. |
Recuperar y consultar esta solicitud
Usa el mismo identificador incluso después de perder la conexión. Si resultStored es false, recupera la salida mediante la acción correspondiente de historial, resultado o descarga. Nunca inicies una segunda generación solo para comprobar el progreso.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"}'
HTTP 200
{
"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
}
}
}
}
Notas de la operación
- Usa un requestId UUID v4 para esta mutación y reutilízalo con argumentos idénticos al reintentar. Las acciones de larga duración devuelven primero una solicitud running; este ejemplo es el resultado completado del controlador disponible en action_request_get.
- Carga entre 1–3 muestras de audio propias y usa sus valores fileKey completados. Los formatos de muestra compatibles son MP3, WAV, M4A, OGG y Opus; cada archivo debe tener contenido y un máximo de 20 MiB (20,971,520 bytes). Se rechazan las URL remotas y las cargas de otras cuentas.
- Las muestras deben sumar al menos 10 segundos y como máximo 120 segundos de audio legible. El valor predeterminado de trimToMaxDuration es false; establécelo en true para recortar proporcionalmente las muestras que sumen más de 120 segundos.
- hasPermission debe ser el booleano JSON true, que confirma el permiso para cada muestra. Se rechaza un valor de cadena como “true”.
- name debe contener entre 1–80 caracteres tras eliminar los espacios al principio y al final. El campo opcional language acepta un código de 2–3 letras con subetiquetas opcionales y un máximo de 35 caracteres.
- Esta acción guarda directamente la voz clonada y ocupa una plaza de voz TTS guardada. No consume la prueba única de vista previa de clonación.
- Usa el voice.id devuelto en tts_generate. Para una clonación directa, su UUID es el requestId; voices_delete recibe ese UUID sin el prefijo clone:.
- El campo language aceptado no cambia el flujo de clonación con guardado directo. Elige voices_preview_clone cuando necesites un guion de vista previa para un idioma concreto.
- El historial de síntesis de voz y las voces personalizadas pertenecen a la cuenta autenticada. La facturación del equipo no concede acceso a las síntesis de voz ni a las voces de otro miembro.
Uso
Cada invocación correcta consume una llamada mensual de API/MCP. También se aplican los créditos multimedia y las cuotas de generación propias de la operación.Errores
| Estado HTTP | Código | Significado o solución |
|---|---|---|
| 400 | CREDENTIAL_IN_QUERY | Se han proporcionado credenciales en un parámetro de consulta access_token o api_key. Envía las credenciales en las cabeceras. |
| 400 | IDEMPOTENCY_CONFLICT | La cabecera Idempotency-Key y el campo requestId del cuerpo deben coincidir. |
| 400 | INVALID_REQUEST_ID | Proporciona un UUID v4 en requestId o Idempotency-Key. |
| 400 | VALIDATION_ERROR | La entrada no coincide con el esquema de la acción; consulta details para ver los errores de los campos. |
| 400 | VOICE_CLONE_INVALID_AUDIO | Una muestra subida no tiene una duración de audio positiva que se pueda leer. |
| 400 | VOICE_CLONE_INVALID_FILE_SIZE | Una muestra almacenada está vacía o supera 20 MiB. |
| 400 | VOICE_CLONE_INVALID_FILE_TYPE | Una muestra no es audio MP3, WAV, M4A, OGG ni Opus. |
| 400 | VOICE_CLONE_SAMPLE_TOO_LONG | Las muestras combinadas superan 120 segundos y no se habilitó el recorte. |
| 400 | VOICE_CLONE_SAMPLE_TOO_SHORT | Las muestras combinadas contienen menos de 10 segundos de audio. |
| 400 | VOICE_SAMPLE_NOT_OWNED | Una clave de muestra es insegura o no pertenece a la cuenta autenticada. |
| 401 | API_KEY_EXPIRED | La clave API ha caducado. |
| 401 | INVALID_API_KEY | Proporciona una clave de API válida que no haya caducado. |
| 401 | INVALID_CREDENTIAL | La cabecera Authorization tiene un formato incorrecto o entra en conflicto con x-api-key. |
| 401 | MISSING_CREDENTIAL | No se proporcionó ninguna credencial de cabecera utilizable o superaba 4096 caracteres. |
| 401 | USER_NOT_FOUND | La cuenta de la credencial ya no existe. |
| 403 | ACCOUNT_UNAVAILABLE | La cuenta que realiza la acción o la cuenta de facturación no está disponible o se está eliminando. |
| 403 | AMBIGUOUS_TEAM_API_KEY | El usuario de la credencial pertenece a más de un equipo, por lo que el contexto de facturación es ambiguo. |
| 403 | INSUFFICIENT_SCOPE | Concede todos los permisos necesarios o elige otra credencial. |
| 403 | INTEGRATION_PLAN_UNSUPPORTED | No se han podido verificar los límites de integración de la cuenta. |
| 403 | SUBSCRIPTION_REQUIRED | Usa una suscripción de pago activa. |
| 403 | TEAM_OWNER_NOT_FOUND | No se pudo encontrar la cuenta del propietario efectivo del equipo. |
| 403 | VOICE_CLONING_REQUIRES_PAID_PLAN | El plan actual no permite guardar voces TTS personalizadas. |
| 404 | VOICE_CLONE_NOT_FOUND | La solicitud de clonación no pertenece a la cuenta autenticada o ya no está disponible. |
| 409 | CONCURRENT_ACTION_LIMIT_REACHED | Esta cuenta ya tiene 10 acciones de integración en ejecución. Consulta una solicitud existente antes de iniciar otra. |
| 409 | IDEMPOTENCY_CONFLICT | Reutiliza un identificador solo con la misma operación y los mismos argumentos. |
| 409 | VOICE_CLONE_IN_PROGRESS | Aún se está creando un clon con este requestId. |
| 409 | VOICE_CLONE_LIMIT_REACHED | Todos los espacios de voces TTS personalizadas guardadas están ocupados. |
| 409 | VOICE_CREATION_IN_PROGRESS | Los cambios de voz están bloqueados mientras se elimina la cuenta. |
| 429 | INTEGRATION_MONTHLY_LIMIT_REACHED | Espera al restablecimiento mensual o cambia de plan. |
| 429 | INTEGRATION_RATE_LIMIT_REACHED | Espera el tiempo indicado en Retry-After cuando esté presente y aplica esperas progresivas. |
| 500 | INTERNAL_ERROR | Comprueba el estado de la solicitud guardada y el historial del recurso antes de decidir si reintentas una modificación. |
| 502 | INTERNAL_ERROR | No se pudo completar la acción o confirmar su resultado. Consulta el estado de la solicitud y el historial del recurso antes de iniciar otra generación. |
| 503 | ACTION_RESULT_UNAVAILABLE | La acción se ejecutó, pero no se pudo guardar su resultado. Revisa el estado de la solicitud guardada y el historial del recurso antes de iniciar una nueva generación. |
| 503 | SERVER_RESTARTING | El servidor se está reiniciando. Reinténtalo en breve y conserva el mismo identificador de solicitud para una modificación. |
{
"code": "INSUFFICIENT_SCOPE",
"message": "This credential does not permit the requested action.",
"status": 403,
"details": {
"requiredScopes": ["voices:write"]
}
}
¿Esta página le ayudó?

