curl --request POST 'https://api.voicecheap.ai/v1/actions/tts_continue' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"requestId":"284a861a-4da8-4d67-ad48-8123e76c8e91","historyId":"free-ebdb6d6f77433edf7c0169994cdce394f1c9c366e4d98cd4762a037cadea0ae4"}'
const input = {
requestId: '284a861a-4da8-4d67-ad48-8123e76c8e91',
historyId: 'free-ebdb6d6f77433edf7c0169994cdce394f1c9c366e4d98cd4762a037cadea0ae4',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/tts_continue', {
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/tts_continue",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91", "historyId": "free-ebdb6d6f77433edf7c0169994cdce394f1c9c366e4d98cd4762a037cadea0ae4"},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
{
"data": {
"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91",
"status": "running",
"pollAction": "action_request_get",
"pollAfterSeconds": 5
},
"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91"
}
{
"data": {
"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91",
"historyId": "free-ebdb6d6f77433edf7c0169994cdce394f1c9c366e4d98cd4762a037cadea0ae4",
"status": "completed",
"characterCount": 12,
"previewEndIndex": null,
"downloadUrl": "https://files.example.com/completed-preview-speech.mp3"
},
"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91"
}
{
"data": {
"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91",
"operation": "tts_continue",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "running",
"pollAfterSeconds": 5
},
"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91"
}
{
"data": {
"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91",
"operation": "tts_continue",
"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"
}
Conversão de texto em fala
Concluir uma prévia de fala
Gere o restante de uma prévia de fala que pertence a você quando a conta atual tiver acesso. Chamadas repetidas retornam o áudio concluído sem nova cobrança de caracteres.
POST
/
v1
/
actions
/
tts_continue
curl --request POST 'https://api.voicecheap.ai/v1/actions/tts_continue' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"requestId":"284a861a-4da8-4d67-ad48-8123e76c8e91","historyId":"free-ebdb6d6f77433edf7c0169994cdce394f1c9c366e4d98cd4762a037cadea0ae4"}'
const input = {
requestId: '284a861a-4da8-4d67-ad48-8123e76c8e91',
historyId: 'free-ebdb6d6f77433edf7c0169994cdce394f1c9c366e4d98cd4762a037cadea0ae4',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/tts_continue', {
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/tts_continue",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91", "historyId": "free-ebdb6d6f77433edf7c0169994cdce394f1c9c366e4d98cd4762a037cadea0ae4"},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
{
"data": {
"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91",
"status": "running",
"pollAction": "action_request_get",
"pollAfterSeconds": 5
},
"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91"
}
{
"data": {
"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91",
"historyId": "free-ebdb6d6f77433edf7c0169994cdce394f1c9c366e4d98cd4762a037cadea0ae4",
"status": "completed",
"characterCount": 12,
"previewEndIndex": null,
"downloadUrl": "https://files.example.com/completed-preview-speech.mp3"
},
"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91"
}
{
"data": {
"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91",
"operation": "tts_continue",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "running",
"pollAfterSeconds": 5
},
"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91"
}
{
"data": {
"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91",
"operation": "tts_continue",
"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"
}
Gere o restante de uma prévia de fala que pertence a você quando a conta atual tiver acesso. Chamadas repetidas retornam o áudio concluído sem nova cobrança de caracteres.
Permissões necessárias:
POST https://api.voicecheap.ai/v1/actions/tts_continue
Autenticação e permissões
string
obrigatório
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.
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
string
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}$.string
obrigatório
ID do histórico retornado por tts_generate ou tts_list.Padrão:
^(free-)?[0-9a-f]{64}$.Esquema de entrada completo
Esquema de entrada completo
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.
{
"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}$"
},
"historyId": {
"type": "string",
"pattern": "^(free-)?[0-9a-f]{64}$",
"description": "History ID returned by tts_generate or tts_list."
}
},
"required": ["historyId"],
"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.curl --request POST 'https://api.voicecheap.ai/v1/actions/tts_continue' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"requestId":"284a861a-4da8-4d67-ad48-8123e76c8e91","historyId":"free-ebdb6d6f77433edf7c0169994cdce394f1c9c366e4d98cd4762a037cadea0ae4"}'
const input = {
requestId: '284a861a-4da8-4d67-ad48-8123e76c8e91',
historyId: 'free-ebdb6d6f77433edf7c0169994cdce394f1c9c366e4d98cd4762a037cadea0ae4',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/tts_continue', {
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/tts_continue",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91", "historyId": "free-ebdb6d6f77433edf7c0169994cdce394f1c9c366e4d98cd4762a037cadea0ae4"},
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 concluídos do áudio completo de uma prévia do aplicativo pertencente ao usuário. O historyId original é mantido.{
"data": {
"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91",
"status": "running",
"pollAction": "action_request_get",
"pollAfterSeconds": 5
},
"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91"
}
{
"data": {
"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91",
"historyId": "free-ebdb6d6f77433edf7c0169994cdce394f1c9c366e4d98cd4762a037cadea0ae4",
"status": "completed",
"characterCount": 12,
"previewEndIndex": null,
"downloadUrl": "https://files.example.com/completed-preview-speech.mp3"
},
"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91"
}
{
"data": {
"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91",
"operation": "tts_continue",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "running",
"pollAfterSeconds": 5
},
"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91"
}
{
"data": {
"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91",
"operation": "tts_continue",
"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.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_continue"}'
HTTP 200
{
"data": {
"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91",
"operation": "tts_continue",
"status": "completed",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"resultStored": true,
"result": {
"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91",
"historyId": "free-ebdb6d6f77433edf7c0169994cdce394f1c9c366e4d98cd4762a037cadea0ae4",
"status": "completed",
"characterCount": 12,
"previewEndIndex": null,
"downloadUrl": "https://files.example.com/completed-preview-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.
- Use um historyId de prévia existente pertencente à conta, obtido no aplicativo ou em tts_list após mudar para um plano superior. Esta ação não pode criar uma nova prévia gratuita.
- O roteiro restante conta para a cota atual de caracteres TTS. Concluir repetidamente a mesma prévia reutiliza o áudio concluído sem gastar esses caracteres novamente.
- Se o item já estiver concluído, seu áudio atual será retornado. O characterCount do resultado descreve o roteiro original completo, e previewEndIndex é null após o desbloqueio.
- 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 | VALIDATION_ERROR | A entrada não corresponde ao esquema da ação; inspecione details para ver os erros dos campos. |
| 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 | É necessário um plano pago para a geração de fala pela integração, incluindo a conclusão de prévias do aplicativo. |
| 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. |
| 404 | TEXT_TO_SPEECH_HISTORY_NOT_FOUND | O item do histórico de fala não existe ou pertence a outra conta. |
| 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 | A conclusão da prévia ainda está em execução. |
| 409 | TEXT_TO_SPEECH_REQUEST_CONFLICT | A requisição subjacente de conclusão da prévia conflita com a entrada armazenada. |
| 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 | Não há caracteres TTS incluídos e comprados suficientes para o restante do roteiro. |
| 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. |
{
"code": "INSUFFICIENT_SCOPE",
"message": "This credential does not permit the requested action.",
"status": 403,
"details": {
"requiredScopes": ["tts:write"]
}
}
Esta página foi útil?