> ## 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.

# Consultar uma voz de dublagem

> Consulte os metadados e um exemplo reproduzível de uma voz de dublagem do catálogo ou de uma voz personalizada que lhe pertence.

Consulte os metadados e um exemplo reproduzível de uma voz de dublagem do catálogo ou de uma voz personalizada que lhe pertence.

```http theme={null}
POST https://api.voicecheap.ai/v1/actions/dubbing_voices_get
```

## Autenticação e permissões

**x-api-key** `string` *required*

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: `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

**voiceId** `string` *required*

Valor de texto.

Comprimento mínimo: 1. Comprimento máximo: 255. Padrão: `^[A-Za-z0-9_-]+$`.

**locale** `string`

Valor de texto.

Valores aceitos: "en", "fr", "es", "de", "it", "pt", "pl", "zh", "ja". Valor padrão: "en".

> [accordion] 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.
>
> ```json theme={null}
> {
>   "type": "object",
>   "properties": {
>     "voiceId": {
>       "type": "string",
>       "minLength": 1,
>       "maxLength": 255,
>       "pattern": "^[A-Za-z0-9_-]+$"
>     },
>     "locale": {
>       "default": "en",
>       "type": "string",
>       "enum": ["en", "fr", "es", "de", "it", "pt", "pl", "zh", "ja"]
>     }
>   },
>   "required": ["voiceId"],
>   "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.

```bash cURL theme={null}
curl --request POST 'https://api.voicecheap.ai/v1/actions/dubbing_voices_get' \
  --header "x-api-key: $VOICECHEAP_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{"voiceId":"dubbing_voice_R8q3k9Yp","locale":"en"}'
```

```javascript JavaScript theme={null}
const input = {
  voiceId: 'dubbing_voice_R8q3k9Yp',
  locale: 'en',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/dubbing_voices_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);
```

```python Python theme={null}
import os
import requests

response = requests.post(
    "https://api.voicecheap.ai/v1/actions/dubbing_voices_get",
    headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
    json={"voiceId": "dubbing_voice_R8q3k9Yp", "locale": "en"},
    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 voz de dublagem do catálogo ou personalizada pertencente à conta, com seus metadados públicos e exemplo reproduzível opcional.

```json HTTP 200 theme={null}
{
  "data": {
    "id": "dubbing_voice_R8q3k9Yp",
    "name": "Studio narrator",
    "source": "custom",
    "previewUrl": "https://files.example.com/dubbing-narrator.mp3"
  }
}
```

## Campos do resultado

| Campo | Descrição |
| - | - |
| `data.id` | ID opaco de voz de dublagem; use em operações de dublagem, não em tts\_generate. |
| `data.name` | Nome de exibição da voz na localidade solicitada, quando há metadados localizados disponíveis. |
| `data.source` | custom para vozes de dublagem salvas pertencentes ao usuário, ou catalog. |
| `data.previewUrl` | URL absoluta opcional de um exemplo que pode ser reproduzido. |
| `data.language` | Código de idioma opcional do catálogo. Vozes personalizadas geralmente omitem metadados de idioma. |
| `data.languages` | Lista opcional de códigos de idioma do catálogo. |
| `data.accent` | Sotaque opcional e localizado do catálogo. |
| `data.description` | Descrição localizada opcional do catálogo. |
| `data.age` | Descrição opcional e localizada da idade no catálogo. |
| `data.gender` | Descrição localizada opcional de gênero do catálogo. |
| `data.useCase` | Caso de uso localizado opcional do catálogo. |
| `data.category` | Categoria localizada opcional do catálogo. |

## Notas da operação

* Use voiceId de dubbing\_voices\_list. É um ID opaco de 1–255 caracteres que contém apenas letras, dígitos, sublinhados e hifens.
* locale tem os mesmos padrões e valores aceitos de dubbing\_voices\_list. As vozes do catálogo podem incluir metadados localizados de language, accent, description, age, gender, useCase e category.
* As vozes personalizadas pertencentes ao usuário retornam source: custom e previewUrl opcional; elas omitem os campos de idioma do catálogo. audioExampleUrl de uma resposta bruta de clonagem é representado aqui como previewUrl.
* 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 | `DUBBING_VOICE_NOT_FOUND` | A voz não está no catálogo disponível nem nas vozes de dublagem salvas da conta autenticada. |
| 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. |

```json theme={null}
{
  "code": "INSUFFICIENT_SCOPE",
  "message": "This credential does not permit the requested action.",
  "status": 403,
  "details": {
    "requiredScopes": ["voices:read"]
  }
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.