curl --request POST 'https://api.voicecheap.ai/v1/actions/voices_list' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{}'
const input = {};
const response = await fetch('https://api.voicecheap.ai/v1/actions/voices_list', {
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_list",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
{
"data": {
"voices": [
{
"accent": "original",
"id": "clone:33333333-3333-4333-8333-333333333333",
"name": "Studio narrator",
"previewUrl": "https://files.example.com/saved-narrator.mp3",
"source": "clone"
},
{
"id": "933563129e564b19a115bedd57b7406a",
"name": "Sarah",
"accent": "english",
"gender": "female",
"style": "conversational",
"previewFileName": "sarah-en.mp3",
"source": "catalog"
}
],
"cloneUsage": {
"canClone": true,
"limit": 10,
"remaining": 9,
"used": 1
},
"voicePreviews": [
{
"id": "44444444-4444-4444-8444-444444444444",
"kind": "clone",
"name": "Studio narrator",
"previewUrl": "https://files.example.com/narrator-preview.mp3",
"expiresAt": 1792238400000,
"durationSeconds": 10
}
],
"creationUsage": {
"cloneTrial": {
"limit": 1,
"used": 1,
"remaining": 0
},
"design": {
"limit": 5,
"used": 0,
"remaining": 5,
"resetsAt": 1792195200000
},
"previewExpiresAfterHours": 24
}
}
}
Voces de texto a voz
Listar voces y vistas previas de voz
Lista las voces de texto a voz disponibles, tus voces personalizadas guardadas, las vistas previas reproducibles que no han caducado y tus cuotas de creación de voces.
POST
/
v1
/
actions
/
voices_list
curl --request POST 'https://api.voicecheap.ai/v1/actions/voices_list' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{}'
const input = {};
const response = await fetch('https://api.voicecheap.ai/v1/actions/voices_list', {
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_list",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
{
"data": {
"voices": [
{
"accent": "original",
"id": "clone:33333333-3333-4333-8333-333333333333",
"name": "Studio narrator",
"previewUrl": "https://files.example.com/saved-narrator.mp3",
"source": "clone"
},
{
"id": "933563129e564b19a115bedd57b7406a",
"name": "Sarah",
"accent": "english",
"gender": "female",
"style": "conversational",
"previewFileName": "sarah-en.mp3",
"source": "catalog"
}
],
"cloneUsage": {
"canClone": true,
"limit": 10,
"remaining": 9,
"used": 1
},
"voicePreviews": [
{
"id": "44444444-4444-4444-8444-444444444444",
"kind": "clone",
"name": "Studio narrator",
"previewUrl": "https://files.example.com/narrator-preview.mp3",
"expiresAt": 1792238400000,
"durationSeconds": 10
}
],
"creationUsage": {
"cloneTrial": {
"limit": 1,
"used": 1,
"remaining": 0
},
"design": {
"limit": 5,
"used": 0,
"remaining": 5,
"resetsAt": 1792195200000
},
"previewExpiresAfterHours": 24
}
}
}
Lista las voces de texto a voz disponibles, tus voces personalizadas guardadas, las vistas previas reproducibles que no han caducado y tus cuotas de creación de voces.
Permisos necesarios:
POST https://api.voicecheap.ai/v1/actions/voices_list
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:read.
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
Envía un objeto JSON vacío. Esta acción no tiene campos de entrada.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": {},
"additionalProperties": false
}
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_list' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{}'
const input = {};
const response = await fetch('https://api.voicecheap.ai/v1/actions/voices_list', {
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_list",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
Respuesta
Una primera ejecución correcta devuelve HTTP 200 con el resultado de la operación en data. Una repetición puede devolver el estado de la solicitud guardada en su lugar. El ejemplo muestra una respuesta admitida, no todos los campos opcionales. Voces TTS disponibles del catálogo y voces personalizadas guardadas que pertenecen a la cuenta, cuota de espacios guardados, vistas previas activas sin guardar y cuotas de creación de voces.{
"data": {
"voices": [
{
"accent": "original",
"id": "clone:33333333-3333-4333-8333-333333333333",
"name": "Studio narrator",
"previewUrl": "https://files.example.com/saved-narrator.mp3",
"source": "clone"
},
{
"id": "933563129e564b19a115bedd57b7406a",
"name": "Sarah",
"accent": "english",
"gender": "female",
"style": "conversational",
"previewFileName": "sarah-en.mp3",
"source": "catalog"
}
],
"cloneUsage": {
"canClone": true,
"limit": 10,
"remaining": 9,
"used": 1
},
"voicePreviews": [
{
"id": "44444444-4444-4444-8444-444444444444",
"kind": "clone",
"name": "Studio narrator",
"previewUrl": "https://files.example.com/narrator-preview.mp3",
"expiresAt": 1792238400000,
"durationSeconds": 10
}
],
"creationUsage": {
"cloneTrial": {
"limit": 1,
"used": 1,
"remaining": 0
},
"design": {
"limit": 5,
"used": 0,
"remaining": 5,
"resetsAt": 1792195200000
},
"previewExpiresAfterHours": 24
}
}
}
Campos del resultado
| Campo | Descripción |
|---|---|
data.voices | Voces TTS guardadas pertenecientes al usuario, seguidas de las voces disponibles del catálogo. |
data.voices[].id | ID de selección TTS para tts_generate; los valores personalizados usan clone:<UUID>. |
data.voices[].name | Nombre visible de la voz. |
data.voices[].source | catalog o clone. |
data.voices[].accent | Acento de la voz; original para las voces personalizadas. |
data.voices[].gender | Género opcional de la voz del catálogo. |
data.voices[].style | Estilo opcional de interpretación de la voz del catálogo. |
data.voices[].previewFileName | Nombre de archivo opcional de la vista previa incluida en el catálogo; no es una URL de descarga. |
data.voices[].previewUrl | URL opcional de reproducción; las URL de voces personalizadas son temporales. |
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. |
data.voicePreviews | Todas las vistas previas actualmente activas sin guardar de esta cuenta, incluidos los candidatos de solicitudes anteriores. |
data.voicePreviews[].id | UUID v4 de vista previa usado por voices_preview_get y voices_save_preview. |
data.voicePreviews[].kind | clone o design. |
data.voicePreviews[].name | Nombre visible de la vista previa; los candidatos diseñados añaden un número al nombre solicitado. |
data.voicePreviews[].previewUrl | URL temporal de audio reproducible. Solicita una URL nueva con voices_preview_get mientras la vista previa siga activa. |
data.voicePreviews[].expiresAt | Caducidad de la vista previa como marca de tiempo Unix en milisegundos. |
data.voicePreviews[].durationSeconds | Duración del audio de vista previa en segundos. |
data.creationUsage.cloneTrial | Cuota de prueba de vista previa de clonación para toda la vida de la cuenta con limit, used y remaining. |
data.creationUsage.design | Cuota diaria de diseño de voces con limit, used, remaining y resetsAt en milisegundos Unix. |
data.creationUsage.previewExpiresAfterHours | Duración de una vista previa sin guardar en horas, actualmente 24. |
Notas de la operación
- El catálogo del ejemplo está abreviado. La acción devuelve la biblioteca TTS disponible con las voces personalizadas guardadas antes de las entradas del catálogo.
- Usa voices[].id en tts_generate. Las voces guardadas usan clone:<UUID>; los ID del catálogo son opacos. Estos ID son independientes de dubbing_voices_list.
- Las entradas del catálogo incluyen accent, gender, style y previewFileName; previewUrl es opcional. Las entradas personalizadas guardadas incluyen accent: original, source: clone y una previewUrl temporal.
- canClone indica si el plan admite voces TTS personalizadas guardadas; remaining indica las plazas libres. Las creaciones reservadas pueden contar para used.
- voicePreviews solo incluye candidatos propios, sin guardar, listos y sin caducar. Una vista previa dura 24 horas; su URL reproducible puede caducar antes.
- cloneTrial es una cuota de una vista previa de clonación para toda la vida de la cuenta. Los planes de pago tienen cinco solicitudes de diseño por día UTC; cada diseño completado correctamente crea dos candidatos. creationUsage indica la cuota actual y el momento de restablecimiento.
- 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 | VALIDATION_ERROR | La entrada no coincide con el esquema de la acción; consulta details para ver los errores de los campos. |
| 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 | 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. |
| 404 | USER_NOT_FOUND | La cuenta autenticada ya no existe. |
| 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. |
| 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:read"]
}
}
¿Esta página le ayudó?

