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

# Clonar uma voz de dublagem

> Crie e salve uma voz personalizada de dublagem de vídeo a partir de uma amostra de áudio enviada que lhe pertence, com permissão explícita. Usa o limite de vozes personalizadas do aplicativo e inclui um exemplo de áudio. Reutilize requestId para evitar uma criação duplicada.

Crie e salve uma voz personalizada de dublagem de vídeo a partir de uma amostra de áudio enviada que lhe pertence, com permissão explícita. Usa o limite de vozes personalizadas do aplicativo e inclui um exemplo de áudio. Reutilize requestId para evitar uma criação duplicada.

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

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

**requestId** `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}$`.

**name** `string` *required*

Valor de texto.

Comprimento mínimo: 1. Comprimento máximo: 80.

**fileKey** `string` *required*

Valor de texto.

Comprimento mínimo: 1. Comprimento máximo: 1024.

**hasPermission** `boolean` *required*

Valor booleano.

Valor obrigatório: true.

> [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": {
>     "requestId": {
>       "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}$",
>       "description": "UUID v4 for this action. Reuse the same ID with identical arguments on retries."
>     },
>     "name": {
>       "type": "string",
>       "minLength": 1,
>       "maxLength": 80
>     },
>     "fileKey": {
>       "type": "string",
>       "minLength": 1,
>       "maxLength": 1024
>     },
>     "hasPermission": {
>       "type": "boolean",
>       "const": true
>     }
>   },
>   "required": ["name", "fileKey", "hasPermission"],
>   "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/dubbing_voices_clone' \
  --header "x-api-key: $VOICECHEAP_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{"requestId":"284a861a-4da8-4d67-ad48-8123e76c8e91","name":"Studio narrator","fileKey":"uploads/example-user/66666666-6666-4666-8666-666666666666-narrator.wav","hasPermission":true}'
```

```javascript JavaScript theme={null}
const input = {
  requestId: '284a861a-4da8-4d67-ad48-8123e76c8e91',
  name: 'Studio narrator',
  fileKey: 'uploads/example-user/66666666-6666-4666-8666-666666666666-narrator.wav',
  hasPermission: true,
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/dubbing_voices_clone', {
  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_clone",
    headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
    json={"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91", "name": "Studio narrator", "fileKey": "uploads/example-user/66666666-6666-4666-8666-666666666666-narrator.wav", "hasPermission": True},
    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.

A voz de dublagem personalizada salva, incluindo ID, nome e exemplo de áudio opcional. Não há um envelope voice ou cloneUsage no estilo TTS.

```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": {
    "id": "dubbing_voice_R8q3k9Yp",
    "name": "Studio narrator",
    "audioExampleUrl": "https://files.example.com/dubbing-narrator.mp3"
  },
  "requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91"
}
```

```json HTTP 202 replay_running theme={null}
{
  "data": {
    "requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91",
    "operation": "dubbing_voices_clone",
    "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": "dubbing_voices_clone",
    "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.id` | ID opaco de uma voz de dublagem salva. |
| `data.name` | Nome de exibição da voz salva. |
| `data.audioExampleUrl` | URL opcional de áudio de exemplo reproduzível. As respostas de listagem e consulta expõem esse campo como previewUrl. |

## 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":"dubbing_voices_clone"}'
```

```json HTTP 200 theme={null}
{
  "data": {
    "requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91",
    "operation": "dubbing_voices_clone",
    "status": "completed",
    "createdAt": 1792144800000,
    "updatedAt": 1792144820000,
    "resultStored": true,
    "result": {
      "id": "dubbing_voice_R8q3k9Yp",
      "name": "Studio narrator",
      "audioExampleUrl": "https://files.example.com/dubbing-narrator.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.
* Esta ação aceita um envio de áudio concluído pertencente ao usuário e exige hasPermission: true como booleano JSON. Não aceita uma URL remota nem o fileKey de outra conta.
* As extensões de amostra compatíveis são AAC, AC3, EAC3, FLAC, M4A, X-M4A, MP2, MP3, OGG e WAV. O arquivo deve ser de áudio legível e não vazio, estar dentro do limite de envio do plano e ter no máximo 250,000,000 bytes (250 MB).
* A família dedicada voices*upload*\* é mais restrita: MP3, WAV, M4A, OGG ou Opus e no máximo 20 MiB por upload. Um arquivo aceito por essa família de upload ainda deve corresponder aos tipos de amostra compatíveis com esta ação de dublagem; Opus não é compatível aqui.
* name contém 1–80 caracteres após a remoção de espaços nas extremidades e não pode conter caracteres de controle.
* A regra de duração combinada de amostras de 10–120 segundos para clonagem de voz TTS não se aplica a esta ação. Sua amostra deve ter uma duração positiva legível e não pode exceder 45 minutos; o áudio não é cortado automaticamente para esse limite.
* Usa a cota de vagas de vozes de dublagem personalizadas salvas da conta. Chame dubbing\_voices\_list para obter cloneUsage atualizado; o próprio resultado de clonagem não o inclui.
* Use o id opaco retornado para dublagem. Ele não tem prefixo clone: e não pode ser usado como seleção de voz TTS.
* 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 | `BAD_REQUEST` | A amostra não tem uma duração positiva legível, excede o limite de duração de 45 minutos para clonagem de dublagem ou é recusada por ser longa demais. |
| 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. |
| 400 | `VOICE_NAME_INVALID` | O nome está vazio, é longo demais ou contém um caractere de controle. |
| 400 | `VOICE_SAMPLE_INVALID_SIZE` | A amostra está vazia, seus bytes reais não correspondem ao tamanho declarado ou ela excede o limite do plano atual ou 250 MB. |
| 400 | `VOICE_SAMPLE_INVALID_TYPE` | O nome do arquivo da amostra não é um formato de áudio compatível com dublagem. |
| 400 | `VOICE_SAMPLE_NOT_OWNED` | A amostra enviada não é segura ou não pertence à conta autenticada. |
| 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 | `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 | `DUBBING_VOICE_LIMIT_REACHED` | Todas as vagas de vozes de dublagem personalizadas salvas estão ocupadas. |
| 409 | `IDEMPOTENCY_CONFLICT` | Este requestId já foi usado com dados de entrada de voz de dublagem diferentes. |
| 409 | `VOICE_MUTATION_IN_PROGRESS` | Outra alteração de voz de dublagem está em execução para esta conta. |
| 409 | `VOICE_MUTATION_LEASE_LOST` | A mutação perdeu sua reserva de execução. Inspecione o status da requisição e as vozes salvas antes de tentar novamente. |
| 409 | `VOICE_REQUEST_ALREADY_STARTED` | Esta requisição de voz foi iniciada anteriormente, mas não tem resultado final confirmado. Liste as vozes e inspecione o status da requisição antes de iniciar outra. |
| 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` | Não foi possível concluir a ação de voz. Inspecione o status da requisição e as vozes salvas antes de iniciar uma nova mutaçã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": ["voices:write"]
  }
}
```


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