curl --request POST 'https://api.voicecheap.ai/v1/actions/voices_preview_get' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"previewId":"44444444-4444-4444-8444-444444444444"}'
const input = {
previewId: '44444444-4444-4444-8444-444444444444',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/voices_preview_get', {
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_preview_get",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"previewId": "44444444-4444-4444-8444-444444444444"},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
{
"data": {
"id": "44444444-4444-4444-8444-444444444444",
"kind": "clone",
"name": "Studio narrator",
"previewUrl": "https://files.example.com/narrator-preview.mp3",
"expiresAt": 1792238400000,
"durationSeconds": 10
}
}
Vozes de fala
Consultar uma prévia de voz
Obtenha uma URL temporária reproduzível para sua prévia de voz clonada ou criada por descrição ainda não salva. Use voices_save_preview para mantê-la antes que expire.
POST
/
v1
/
actions
/
voices_preview_get
curl --request POST 'https://api.voicecheap.ai/v1/actions/voices_preview_get' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"previewId":"44444444-4444-4444-8444-444444444444"}'
const input = {
previewId: '44444444-4444-4444-8444-444444444444',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/voices_preview_get', {
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_preview_get",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"previewId": "44444444-4444-4444-8444-444444444444"},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
{
"data": {
"id": "44444444-4444-4444-8444-444444444444",
"kind": "clone",
"name": "Studio narrator",
"previewUrl": "https://files.example.com/narrator-preview.mp3",
"expiresAt": 1792238400000,
"durationSeconds": 10
}
}
Obtenha uma URL temporária reproduzível para sua prévia de voz clonada ou criada por descrição ainda não salva. Use voices_save_preview para mantê-la antes que expire.
Permissões necessárias:
POST https://api.voicecheap.ai/v1/actions/voices_preview_get
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.
voices:read.
É 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
obrigatório
Valor de texto.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})$.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": {
"previewId": {
"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})$"
}
},
"required": ["previewId"],
"additionalProperties": false
}
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/voices_preview_get' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"previewId":"44444444-4444-4444-8444-444444444444"}'
const input = {
previewId: '44444444-4444-4444-8444-444444444444',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/voices_preview_get', {
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_preview_get",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"previewId": "44444444-4444-4444-8444-444444444444"},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
Resposta
Uma primeira execução bem-sucedida retorna HTTP 200 com o resultado da operação em data. Uma repetição pode retornar o estado salvo da requisição. O exemplo mostra uma resposta aceita, não todos os campos opcionais. Uma prévia de voz ativa pertencente à conta, com uma URL temporária de reprodução renovada e sua expiração.{
"data": {
"id": "44444444-4444-4444-8444-444444444444",
"kind": "clone",
"name": "Studio narrator",
"previewUrl": "https://files.example.com/narrator-preview.mp3",
"expiresAt": 1792238400000,
"durationSeconds": 10
}
}
Campos do resultado
| Campo | Descrição |
|---|---|
data.id | UUID do candidato para voices_save_preview. |
data.kind | clone ou design. |
data.name | Nome de exibição do candidato. |
data.previewUrl | Nova URL temporária de áudio reproduzível. |
data.expiresAt | Expiração do candidato como um timestamp Unix em milissegundos. |
data.durationSeconds | Duração do áudio de prévia em segundos. |
Notas da operação
- previewId é o UUID do candidato retornado em voicePreviews por voices_preview_clone, voices_design ou voices_list.
- Somente prévias com status ready, não salvas e não expiradas são visíveis. Um candidato salvo passa para voices_list como clone:<previewId>. Candidatos expirados, salvos, ausentes ou pertencentes a outro usuário retornam VOICE_PREVIEW_NOT_FOUND aqui.
- A URL é temporária e pode expirar antes de expiresAt. Salve o candidato escolhido com voices_save_preview antes que a própria prévia expire.
- 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 | 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 | 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 | 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 | USER_NOT_FOUND | A conta autenticada não existe mais. |
| 404 | VOICE_PREVIEW_NOT_FOUND | A prévia está ausente, não pertence à conta, já foi salva ou expirou. |
| 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. |
| 500 | INTERNAL_ERROR | Verifique o estado da requisição salva e o histórico do recurso antes de decidir repetir uma alteraçã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": ["voices:read"]
}
}
Esta página foi útil?

