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

# Listar vozes de dublagem

> Explore o mesmo catálogo de vozes de dublagem do aplicativo e suas vozes personalizadas de dublagem salvas, incluindo exemplos reproduzíveis e sua cota de vozes. Esses IDs são para dublagem de vídeo; voices_list fornece a biblioteca separada de conversão de texto em fala.

Explore o mesmo catálogo de vozes de dublagem do aplicativo e suas vozes personalizadas de dublagem salvas, incluindo exemplos reproduzíveis e sua cota de vozes. Esses IDs são para dublagem de vídeo; voices\_list fornece a biblioteca separada de conversão de texto em fala.

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

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

**locale** `string`

Valor de texto.

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

**language** `string`

Valor de texto.

Comprimento mínimo: 2. Comprimento máximo: 35.

**search** `string`

Valor de texto.

Comprimento máximo: 100.

> [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": {
>     "locale": {
>       "default": "en",
>       "type": "string",
>       "enum": ["en", "fr", "es", "de", "it", "pt", "pl", "zh", "ja"]
>     },
>     "language": {
>       "type": "string",
>       "minLength": 2,
>       "maxLength": 35
>     },
>     "search": {
>       "type": "string",
>       "maxLength": 100
>     }
>   },
>   "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_list' \
  --header "x-api-key: $VOICECHEAP_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{"locale":"en","language":"en","search":"Studio narrator"}'
```

```javascript JavaScript theme={null}
const input = {
  locale: 'en',
  language: 'en',
  search: 'Studio narrator',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/dubbing_voices_list', {
  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_list",
    headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
    json={"locale": "en", "language": "en", "search": "Studio narrator"},
    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.

Vozes de dublagem de vídeo correspondentes do catálogo e personalizadas pertencentes à conta, além da cota atual de vozes de dublagem salvas.

```json HTTP 200 theme={null}
{
  "data": {
    "voices": [
      {
        "id": "dubbing_voice_R8q3k9Yp",
        "name": "Studio narrator",
        "source": "custom",
        "previewUrl": "https://files.example.com/dubbing-narrator.mp3"
      }
    ],
    "cloneUsage": {
      "limit": 7,
      "used": 1,
      "remaining": 6
    }
  }
}
```

## Campos do resultado

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

## Notas da operação

* Esta é a biblioteca de dublagem de vídeo. Use voices\_list para o catálogo TTS separado e as seleções clone:\<UUID>.
* O padrão de locale é en, e os valores aceitos são en, fr, es, de, it, pt, pl, zh e ja. Textos localizados ausentes usam o inglês ou outra tradução disponível como alternativa.
* search opcional corresponde a uma substring, sem diferenciar maiúsculas de minúsculas, no nome da voz e na descrição localizada, com no máximo 100 caracteres após remover espaços nas extremidades.
* O campo opcional language contém 2–35 caracteres e é comparado exatamente com os metadados language ou languages do catálogo. Vozes sem metadados de idioma, incluindo vozes personalizadas, continuam incluídas.
* A lista não é paginada. Vozes do catálogo e personalizadas têm metadados opcionais diferentes. O uso de vagas de clonagem conta apenas as vozes personalizadas de dublagem salvas.
* O exemplo filtra uma voz personalizada pertencente à conta. Seu campo na lista é previewUrl; a clonagem retorna o mesmo exemplo de áudio em audioExampleUrl.
* 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. |
| 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.