> ## 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. # Gerar fala > Crie fala a partir de texto usando uma voz do catálogo ou uma voz personalizada que lhe pertence. Usa os mesmos créditos de caracteres e limites de plano do aplicativo. Retorna um ID de histórico e uma URL temporária de download do áudio. Reutilize requestId para evitar uma segunda geração. Crie fala a partir de texto usando uma voz do catálogo ou uma voz personalizada que lhe pertence. Usa os mesmos créditos de caracteres e limites de plano do aplicativo. Retorna um ID de histórico e uma URL temporária de download do áudio. Reutilize requestId para evitar uma segunda geração. ```http theme={null} POST https://api.voicecheap.ai/v1/actions/tts_generate ``` ## Autenticação e permissões Envie uma chave de API VoiceCheap neste cabeçalho. Authorization: Bearer com a mesma chave de API também é aceito. Tokens de acesso OAuth são aceitos apenas pelo MCP, não por este endpoint REST. Permissões necessárias: `tts:write`. É necessária uma assinatura paga ativa. As permissões não alteram funções na equipe, propriedade dos recursos, créditos de mídia ou limites do plano. ## Parâmetros Opcional na camada de transporte: o servidor insere um identificador antes da validação quando ele é omitido. Forneça seu próprio UUID v4 estável para recuperar com segurança uma resposta perdida. Formato: "uuid". Padrão: `^[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. Comprimento mínimo: 1. Comprimento máximo: 128000. Um ID de seleção de voz de voices\_list, incluindo IDs clone: para vozes personalizadas salvas. Comprimento mínimo: 1. Comprimento máximo: 255. Valor de texto. Valores aceitos: "text", "pdf". Valor padrão: "text". Valor de texto. Valores aceitos: "default", "cheerful", "calm", "narrator", "dramatic", "whisper", "energetic". Valor padrão: "default". Valor de texto. Comprimento máximo: 300. Valor numérico. Mínimo: 0.5. Máximo: 2. Valor padrão: 1. Valor de texto. Comprimento máximo: 255. O JSON Schema abaixo preserva os nomes exatos dos campos, tipos aninhados, valores padrão, limites e valores aceitos expostos pela descoberta. Regras adicionais entre campos são listadas nas notas da operação. ```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 } ``` ## Idempotência Use um UUID v4 em requestId ou no cabeçalho HTTP Idempotency-Key para cada alteração. Reutilize o mesmo identificador e argumentos idênticos após uma falha de rede. Se ambos forem fornecidos, devem ser iguais. Repetir uma requisição salva não repete a operação nem consome outra chamada mensal. Requisições com falha ou interrompidas não são reiniciadas automaticamente. Qualquer alteração pode retornar HTTP 202 quando uma nova tentativa encontra a mesma requisição ainda em execução, mesmo que a primeira execução normalmente seja síncrona. Se a execução foi concluída, mas resultStored é false, uma nova tentativa retorna HTTP 200 com o estado salvo da requisição em vez do resultado original. Recupere a saída pela ação de histórico, resultado ou download do domínio correspondente. ## Exemplos de requisição Substitua os identificadores de recursos e as chaves de mídia dos exemplos pelos valores retornados para sua conta. Mantenha o identificador da requisição ao tentar novamente a mesma alteração. ```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) ``` ## Resposta Esta operação retorna HTTP 202 enquanto está em execução. Salve requestId e consulte action\_request\_get com esse identificador e o nome da operação original. Os estados de consulta são running, completed, failed e interrupted. Um resultado concluído pode apontar para um processamento de mídia separado; continue com a ação de status ou de saída específica da operação. Metadados da geração de fala concluída e uma URL temporária de download do MP3. O handler não retorna bytes de áudio. ```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 do resultado | Campo | Descrição | | - | - | | `data.requestId` | UUID v4 fornecido para a ação de geração. | | `data.historyId` | ID do histórico de fala pertencente ao usuário: 64 caracteres hexadecimais minúsculos, opcionalmente com o prefixo free- para uma prévia do aplicativo. | | `data.status` | completed quando o resultado da fala está pronto. | | `data.characterCount` | Número de caracteres no texto completo de entrada após remover os espaços das extremidades. | | `data.previewEndIndex` | Posição de caractere que delimita o áudio parcial de prévia, ou null para áudio completo. A geração paga pela integração retorna áudio completo. | | `data.downloadUrl` | URL temporária de download MP3. Solicite uma nova por tts\_download. | ## Recuperar e consultar esta requisição Use o mesmo identificador mesmo após perder a conexão. Se resultStored for false, recupere a saída pela ação correspondente de histórico, resultado ou download. Nunca inicie uma segunda geração apenas para verificar o progresso. ```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 da operação * Use um requestId UUID v4 para esta alteração e reutilize-o com argumentos idênticos ao tentar novamente. Ações de longa duração retornam primeiro uma requisição running; este exemplo é o resultado concluído do handler, disponível em action\_request\_get. * Escolha voice em voices\_list. IDs de vozes de dublagem de dubbing\_voices\_list pertencem a uma biblioteca separada. * Os espaços nas extremidades do texto são removidos. O esquema aceita no máximo 128,000 caracteres; os planos atuais Beginner e Starter permitem 64,000 por geração, enquanto Creator e planos superiores permitem 128,000. O plano atual e os créditos de caracteres TTS disponíveis são verificados novamente antes da geração. * inputType tem text como padrão e pode ser text ou pdf. Mesmo com pdf, forneça o texto extraído em text; esta ação não aceita upload nem URL de PDF. * instructionPreset tem default como padrão e aceita default, cheerful, calm, narrator, dramatic, whisper e energetic. instructions é opcional e limitado a 300 caracteres após a remoção de espaços nas extremidades. speed tem 1 como padrão e varia de 0.5 a 2. * sourceFileName é um metadado opcional, limitado a 255 caracteres após remover espaços nas extremidades, e determina o nome do arquivo de download. * Uma requisição repetida bem-sucedida retorna o áudio salvo sem gerá-lo nem cobrá-lo novamente. As URLs são temporárias; use tts\_download para obter um novo download. * O histórico de fala e as vozes personalizadas pertencem à conta autenticada. O faturamento da equipe não concede acesso à fala nem às vozes de outro membro. ## Uso Cada chamada bem-sucedida consome uma chamada mensal da API/MCP. Os créditos de mídia e as cotas de geração da própria operação também se aplicam. ## Erros | Status HTTP | Código | Significado ou recuperação | | - | - | - | | 400 | `CREDENTIAL_IN_QUERY` | Foram fornecidas credenciais em um parâmetro de consulta access\_token ou api\_key. Envie as credenciais nos cabeçalhos. | | 400 | `IDEMPOTENCY_CONFLICT` | O cabeçalho Idempotency-Key e o campo requestId do corpo devem ser iguais. | | 400 | `INVALID_REQUEST_ID` | Forneça um requestId ou Idempotency-Key no formato UUID v4. | | 400 | `INVALID_VOICE` | A seleção de voz é inválida, não pertence a esta conta ou não está pronta. | | 400 | `TEXT_REQUIRED` | O roteiro está vazio após a remoção das tags de controle de interpretação. | | 400 | `TEXT_TOO_LONG` | O roteiro excede o limite de caracteres por geração do plano atual. | | 400 | `VALIDATION_ERROR` | A entrada não corresponde ao esquema da ação; inspecione details para ver os erros dos campos. | | 400 | `VOICE_UNAVAILABLE` | A voz do catálogo selecionada não está mais disponível; escolha um ID retornado por voices\_list. | | 401 | `API_KEY_EXPIRED` | A chave de API expirou. | | 401 | `INVALID_API_KEY` | Forneça uma chave de API válida e dentro do prazo de validade. | | 401 | `INVALID_CREDENTIAL` | O cabeçalho Authorization está malformado ou entra em conflito com x-api-key. | | 401 | `MISSING_CREDENTIAL` | Nenhuma credencial utilizável foi fornecida no cabeçalho, ou ela excedeu 4096 caracteres. | | 401 | `USER_NOT_FOUND` | A conta da credencial não existe mais. | | 403 | `ACCOUNT_UNAVAILABLE` | A conta que executa a ação ou a conta de cobrança está indisponível ou em processo de exclusão. | | 403 | `AMBIGUOUS_TEAM_API_KEY` | O usuário da credencial pertence a mais de uma equipe, portanto o contexto de cobrança é ambíguo. | | 403 | `INSUFFICIENT_SCOPE` | Conceda todas as permissões necessárias ou escolha outra credencial. | | 403 | `INTEGRATION_PLAN_UNSUPPORTED` | Não foi possível verificar os limites de integração da conta. | | 403 | `PAID_PLAN_REQUIRED` | A conta atual não tem mais um plano pago para geração de fala por integração. | | 403 | `SUBSCRIPTION_REQUIRED` | Use uma assinatura paga ativa. | | 403 | `TEAM_OWNER_NOT_FOUND` | Não foi possível encontrar a conta efetiva do proprietário da equipe. | | 409 | `CONCURRENT_ACTION_LIMIT_REACHED` | Esta conta já tem 10 ações de integração em execução. Consulte uma requisição existente antes de iniciar outra. | | 409 | `IDEMPOTENCY_CONFLICT` | Reutilize um identificador apenas com a mesma operação e os mesmos argumentos. | | 409 | `TEXT_TO_SPEECH_GENERATION_IN_PROGRESS` | Uma requisição de fala idêntica ainda está em processamento. | | 409 | `TEXT_TO_SPEECH_REQUEST_CONFLICT` | Este requestId já foi usado com uma entrada de fala diferente. | | 429 | `INTEGRATION_MONTHLY_LIMIT_REACHED` | Aguarde a renovação do limite mensal ou mude de plano. | | 429 | `INTEGRATION_RATE_LIMIT_REACHED` | Aguarde o prazo de Retry-After, quando presente, e aumente progressivamente o intervalo entre as tentativas. | | 429 | `TEXT_TO_SPEECH_CHARACTER_LIMIT_REACHED` | O roteiro excede o total de caracteres TTS incluídos e comprados disponíveis. | | 500 | `INTERNAL_ERROR` | Verifique o estado da requisição salva e o histórico do recurso antes de decidir repetir uma alteração. | | 502 | `INTERNAL_ERROR` | Não foi possível concluir a ação ou confirmar seu resultado. Inspecione o status da requisição e o histórico do recurso antes de iniciar outra geração. | | 503 | `ACTION_RESULT_UNAVAILABLE` | A ação foi executada, mas não foi possível salvar seu resultado. Inspecione o estado salvo da requisição e o histórico do recurso antes de iniciar uma nova geração. | | 503 | `SERVER_RESTARTING` | O servidor está reiniciando. Tente novamente em breve e mantenha o mesmo identificador de requisição para uma alteração. | ```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.