> ## 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. # Generar voz > Crea voz a partir de texto con una voz del catálogo o una voz personalizada de tu propiedad. Aplica los mismos créditos de caracteres y límites del plan que la aplicación. Devuelve un identificador de historial y una URL de descarga temporal del audio. Reutiliza requestId para evitar una segunda generación. Crea voz a partir de texto con una voz del catálogo o una voz personalizada de tu propiedad. Aplica los mismos créditos de caracteres y límites del plan que la aplicación. Devuelve un identificador de historial y una URL de descarga temporal del audio. Reutiliza requestId para evitar una segunda generación. ```http theme={null} POST https://api.voicecheap.ai/v1/actions/tts_generate ``` ## Autenticación y permisos 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. Permisos necesarios: `tts: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 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}$`. Valor de texto. Longitud mínima: 1. Longitud máxima: 128000. Un ID de selección de voz de voices\_list, incluidos los ID clone: para voces personalizadas guardadas. Longitud mínima: 1. Longitud máxima: 255. Valor de texto. Valores permitidos: "text", "pdf". Valor predeterminado: "text". Valor de texto. Valores permitidos: "default", "cheerful", "calm", "narrator", "dramatic", "whisper", "energetic". Valor predeterminado: "default". Valor de texto. Longitud máxima: 300. Valor numérico. Mínimo: 0.5. Máximo: 2. Valor predeterminado: 1. Valor de texto. Longitud máxima: 255. 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. ```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}$" }, "text": { "type": "string", "minLength": 1, "maxLength": 128000 }, "voice": { "type": "string", "minLength": 1, "maxLength": 255, "description": "A voice selection ID from voices_list, including clone: IDs for saved custom voices." }, "inputType": { "default": "text", "type": "string", "enum": ["text", "pdf"] }, "instructionPreset": { "default": "default", "type": "string", "enum": ["default", "cheerful", "calm", "narrator", "dramatic", "whisper", "energetic"] }, "instructions": { "type": "string", "maxLength": 300 }, "speed": { "default": 1, "type": "number", "minimum": 0.5, "maximum": 2 }, "sourceFileName": { "type": "string", "maxLength": 255 } }, "required": ["text", "voice"], "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. ```bash cURL theme={null} curl --request POST 'https://api.voicecheap.ai/v1/actions/tts_generate' \ --header "x-api-key: $VOICECHEAP_API_KEY" \ --header 'Content-Type: application/json' \ --data '{"requestId":"284a861a-4da8-4d67-ad48-8123e76c8e91","text":"Hello world.","voice":"933563129e564b19a115bedd57b7406a","inputType":"text","instructionPreset":"narrator","instructions":"Speak clearly and leave a short pause at the end.","speed":1,"sourceFileName":"launch-script.txt"}' ``` ```javascript JavaScript theme={null} const input = { requestId: '284a861a-4da8-4d67-ad48-8123e76c8e91', text: 'Hello world.', voice: '933563129e564b19a115bedd57b7406a', inputType: 'text', instructionPreset: 'narrator', instructions: 'Speak clearly and leave a short pause at the end.', speed: 1, sourceFileName: 'launch-script.txt', }; const response = await fetch('https://api.voicecheap.ai/v1/actions/tts_generate', { 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/tts_generate", headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]}, json={"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91", "text": "Hello world.", "voice": "933563129e564b19a115bedd57b7406a", "inputType": "text", "instructionPreset": "narrator", "instructions": "Speak clearly and leave a short pause at the end.", "speed": 1, "sourceFileName": "launch-script.txt"}, 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. Metadatos de generación de voz completada y una URL temporal de descarga de MP3. El controlador no devuelve bytes de audio. ```json HTTP 202 theme={null} { "data": { "requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91", "status": "running", "pollAction": "action_request_get", "pollAfterSeconds": 5 }, "requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91" } ``` ```json HTTP 200 theme={null} { "data": { "requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91", "historyId": "722c80c6412edd4c3dcd625061e1c1feafbb0d54274d95fd8b5ca047f8cdd23d", "status": "completed", "characterCount": 12, "previewEndIndex": null, "downloadUrl": "https://files.example.com/launch-script-speech.mp3" }, "requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91" } ``` ```json HTTP 202 replay_running theme={null} { "data": { "requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91", "operation": "tts_generate", "createdAt": 1792144800000, "updatedAt": 1792144820000, "status": "running", "pollAfterSeconds": 5 }, "requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91" } ``` ```json HTTP 200 replay_completed_without_result theme={null} { "data": { "requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91", "operation": "tts_generate", "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" } ``` ## Campos del resultado | Campo | Descripción | | - | - | | `data.requestId` | UUID v4 proporcionado para la acción de generación. | | `data.historyId` | ID del historial de voz perteneciente al usuario: 64 caracteres hexadecimales en minúsculas, con el prefijo opcional free- para una vista previa de la aplicación. | | `data.status` | completed cuando el resultado de voz está listo. | | `data.characterCount` | Número de caracteres del texto de entrada completo sin espacios al principio ni al final. | | `data.previewEndIndex` | Límite de caracteres del audio de vista previa parcial, o null para el audio completo. La generación mediante integración de pago devuelve el audio completo. | | `data.downloadUrl` | URL temporal de descarga MP3. Solicita una nueva mediante tts\_download. | ## 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. ```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":"284a861a-4da8-4d67-ad48-8123e76c8e91","operation":"tts_generate"}' ``` ```json HTTP 200 theme={null} { "data": { "requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91", "operation": "tts_generate", "status": "completed", "createdAt": 1792144800000, "updatedAt": 1792144820000, "resultStored": true, "result": { "requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91", "historyId": "722c80c6412edd4c3dcd625061e1c1feafbb0d54274d95fd8b5ca047f8cdd23d", "status": "completed", "characterCount": 12, "previewEndIndex": null, "downloadUrl": "https://files.example.com/launch-script-speech.mp3" } } } ``` ## 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. * Elige voice de voices\_list. Los ID de voces de doblaje de dubbing\_voices\_list pertenecen a una biblioteca independiente. * Se eliminan los espacios al principio y al final del texto. El esquema acepta como máximo 128,000 caracteres; los planes actuales Beginner y Starter permiten 64,000 por generación, mientras que Creator y los planes superiores permiten 128,000. El plan actual y los créditos de caracteres TTS disponibles se comprueban de nuevo antes de la generación. * inputType tiene text como valor predeterminado y puede ser text o pdf. Incluso con pdf, proporciona el texto extraído en text; esta acción no acepta la carga de un PDF ni una URL. * instructionPreset tiene default como valor predeterminado y admite default, cheerful, calm, narrator, dramatic, whisper y energetic. instructions es opcional y está limitado a 300 caracteres tras eliminar los espacios de los extremos. speed tiene 1 como valor predeterminado y va de 0.5 a 2. * sourceFileName es un metadato opcional, limitado a 255 caracteres tras eliminar los espacios de los extremos, que determina el nombre del archivo de descarga. * Una solicitud repetida exitosa devuelve el audio guardado sin volver a generarlo ni cobrarlo. Las URL son temporales; usa tts\_download para obtener una descarga renovada. * 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 | `INVALID_VOICE` | La selección de voz no es válida, no pertenece a esta cuenta o no está lista. | | 400 | `TEXT_REQUIRED` | El guion está vacío tras eliminar las etiquetas de control de locución. | | 400 | `TEXT_TOO_LONG` | El guion supera el límite de caracteres por generación del plan actual. | | 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_UNAVAILABLE` | La voz del catálogo seleccionada ya no está disponible; elige un ID devuelto por voices\_list. | | 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 | `PAID_PLAN_REQUIRED` | La cuenta actual ya no tiene un plan de pago para generar voz mediante la integración. | | 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. | | 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 | `TEXT_TO_SPEECH_GENERATION_IN_PROGRESS` | Una solicitud de voz idéntica sigue procesándose. | | 409 | `TEXT_TO_SPEECH_REQUEST_CONFLICT` | Este requestId ya se ha usado con una entrada de voz distinta. | | 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. | | 429 | `TEXT_TO_SPEECH_CHARACTER_LIMIT_REACHED` | El guion supera el total disponible de caracteres TTS incluidos y comprados. | | 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. | ```json theme={null} { "code": "INSUFFICIENT_SCOPE", "message": "This credential does not permit the requested action.", "status": 403, "details": { "requiredScopes": ["tts:write"] } } ``` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.