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

# Criar uma prévia de voz clonada

> Crie uma prévia temporária de voz clonada a partir de 1–3 envios de áudio que lhe pertencem, com permissão explícita. Usa a cota de testes de clonagem do aplicativo. Salve a prévia selecionada antes que expire para mantê-la.

Crie uma prévia temporária de voz clonada a partir de 1–3 envios de áudio que lhe pertencem, com permissão explícita. Usa a cota de testes de clonagem do aplicativo. Salve a prévia selecionada antes que expire para mantê-la.

```http theme={null}
POST https://api.voicecheap.ai/v1/actions/voices_preview_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.

**samples** `array` *required*

Lista de valores. Consulte o esquema de entrada completo para ver a estrutura dos itens.

Mínimo de itens: 1. Máximo de itens: 3.

**hasPermission** `boolean` *required*

Confirme que você tem permissão para clonar a voz da pessoa ouvida em todas as amostras.

Valor obrigatório: true.

**trimToMaxDuration** `boolean`

Valor booleano.

Valor padrão: false.

**language** `string`

Valor de texto.

Comprimento máximo: 35. Padrão: `^[a-z]{2,3}(-[A-Za-z0-9]{2,8})*$`.

> [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": {
>       "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}$"
>     },
>     "name": {
>       "type": "string",
>       "minLength": 1,
>       "maxLength": 80
>     },
>     "samples": {
>       "minItems": 1,
>       "maxItems": 3,
>       "type": "array",
>       "items": {
>         "type": "object",
>         "properties": {
>           "fileKey": {
>             "type": "string",
>             "minLength": 1,
>             "maxLength": 1024,
>             "description": "An uploaded audio fileKey returned by voices_upload_complete for this account."
>           }
>         },
>         "required": ["fileKey"],
>         "additionalProperties": false
>       }
>     },
>     "hasPermission": {
>       "type": "boolean",
>       "const": true,
>       "description": "Confirm that you have permission to clone the person whose voice is in every sample."
>     },
>     "trimToMaxDuration": {
>       "default": false,
>       "type": "boolean"
>     },
>     "language": {
>       "type": "string",
>       "maxLength": 35,
>       "pattern": "^[a-z]{2,3}(-[A-Za-z0-9]{2,8})*$"
>     }
>   },
>   "required": ["name", "samples", "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/voices_preview_clone' \
  --header "x-api-key: $VOICECHEAP_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{"requestId":"284a861a-4da8-4d67-ad48-8123e76c8e91","name":"Studio narrator","samples":[{"fileKey":"uploads/example-user/66666666-6666-4666-8666-666666666666-narrator.wav"}],"hasPermission":true,"trimToMaxDuration":false,"language":"en"}'
```

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

Todas as prévias de voz ativas e não salvas e as cotas de criação atualizadas, incluindo o novo candidato de clonagem.

```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": {
    "voicePreviews": [
      {
        "id": "44444444-4444-4444-8444-444444444444",
        "kind": "clone",
        "name": "Studio narrator",
        "previewUrl": "https://files.example.com/narrator-preview.mp3",
        "expiresAt": 1792238400000,
        "durationSeconds": 10
      }
    ],
    "creationUsage": {
      "cloneTrial": {
        "limit": 1,
        "used": 1,
        "remaining": 0
      },
      "design": {
        "limit": 5,
        "used": 0,
        "remaining": 5,
        "resetsAt": 1792195200000
      },
      "previewExpiresAfterHours": 24
    }
  },
  "requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91"
}
```

```json HTTP 202 replay_running theme={null}
{
  "data": {
    "requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91",
    "operation": "voices_preview_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": "voices_preview_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.voicePreviews` | Todas as prévias atualmente ativas e não salvas desta conta, incluindo candidatos de requisições anteriores. |
| `data.voicePreviews[].id` | UUID v4 da prévia usado por voices\_preview\_get e voices\_save\_preview. |
| `data.voicePreviews[].kind` | clone ou design. |
| `data.voicePreviews[].name` | Nome de exibição da prévia; candidatos criados por design acrescentam um número ao nome solicitado. |
| `data.voicePreviews[].previewUrl` | URL temporária de áudio reproduzível. Solicite uma nova URL com voices\_preview\_get enquanto a prévia permanecer ativa. |
| `data.voicePreviews[].expiresAt` | Expiração da prévia como timestamp Unix em milissegundos. |
| `data.voicePreviews[].durationSeconds` | Duração do áudio de prévia em segundos. |
| `data.creationUsage.cloneTrial` | Cota vitalícia de teste de prévia de clonagem com limit, used e remaining. |
| `data.creationUsage.design` | Cota diária de design de voz com limit, used, remaining e resetsAt em milissegundos Unix. |
| `data.creationUsage.previewExpiresAfterHours` | Tempo de vida de uma prévia não salva em horas, atualmente 24. |

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

```json HTTP 200 theme={null}
{
  "data": {
    "requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91",
    "operation": "voices_preview_clone",
    "status": "completed",
    "createdAt": 1792144800000,
    "updatedAt": 1792144820000,
    "resultStored": true,
    "result": {
      "voicePreviews": [
        {
          "id": "44444444-4444-4444-8444-444444444444",
          "kind": "clone",
          "name": "Studio narrator",
          "previewUrl": "https://files.example.com/narrator-preview.mp3",
          "expiresAt": 1792238400000,
          "durationSeconds": 10
        }
      ],
      "creationUsage": {
        "cloneTrial": {
          "limit": 1,
          "used": 1,
          "remaining": 0
        },
        "design": {
          "limit": 5,
          "used": 0,
          "remaining": 5,
          "resetsAt": 1792195200000
        },
        "previewExpiresAfterHours": 24
      }
    }
  }
}
```

## 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.
* Envie 1–3 amostras de áudio pertencentes à conta e use seus valores fileKey após a conclusão do envio. Os formatos de amostra compatíveis são MP3, WAV, M4A, OGG e Opus; cada arquivo deve ser não vazio e ter no máximo 20 MiB (20,971,520 bytes). URLs remotas e envios de outras contas são recusados.
* As amostras devem totalizar no mínimo 10 segundos e no máximo 120 segundos de áudio legível. O padrão de trimToMaxDuration é false; defina-o como true para cortar proporcionalmente amostras que totalizem mais de 120 segundos.
* hasPermission deve ser o booleano JSON true, confirmando a permissão para cada amostra. Um valor de string como "true" é rejeitado.
* name deve conter 1–80 caracteres após a remoção dos espaços nas extremidades. O campo opcional language aceita um código de 2–3 letras com subtags opcionais e no máximo 35 caracteres.
* Usa o único teste de prévia de clone permitido durante toda a existência da conta. Criar esta prévia não salva uma voz TTS reutilizável nem ocupa uma vaga de voz salva.
* O novo candidato de clonagem tem kind: clone e dura 24 horas. Sua reprodução é limitada a aproximadamente 10 segundos.
* A resposta inclui todas as prévias ativas não salvas. Use voices\_preview\_get para renovar a reprodução e voices\_save\_preview para manter o candidato escolhido em um plano pago.
* language escolhe o roteiro da prévia quando existe um roteiro compatível; não é uma requisição para traduzir a amostra enviada.
* 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. |
| 400 | `VOICE_CLONE_INVALID_AUDIO` | Uma amostra enviada não tem uma duração de áudio positiva legível. |
| 400 | `VOICE_CLONE_INVALID_FILE_SIZE` | Uma amostra armazenada está vazia ou excede 20 MiB. |
| 400 | `VOICE_CLONE_INVALID_FILE_TYPE` | Uma amostra não é áudio MP3, WAV, M4A, OGG ou Opus. |
| 400 | `VOICE_CLONE_SAMPLE_TOO_LONG` | As amostras combinadas excedem 120 segundos e o corte não foi ativado. |
| 400 | `VOICE_CLONE_SAMPLE_TOO_SHORT` | As amostras combinadas contêm menos de 10 segundos de áudio. |
| 400 | `VOICE_SAMPLE_NOT_OWNED` | Uma chave de amostra é insegura 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. |
| 404 | `USER_NOT_FOUND` | A conta autenticada não existe mais. |
| 404 | `VOICE_PREVIEW_NOT_FOUND` | A requisição 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 | `VOICE_CREATION_IN_PROGRESS` | A prévia ainda está sendo criada ou a exclusão da conta bloqueia novos trabalhos de voz. |
| 409 | `VOICE_CREATION_REQUEST_MISMATCH` | Este requestId foi usado para um tipo de voz, configurações ou amostras diferentes. |
| 409 | `VOICE_TRIAL_LIMIT_REACHED` | A conta já usou seu teste de prévia de clonagem disponível uma única vez. |
| 410 | `VOICE_PREVIEW_EXPIRED` | A prévia de voz da requisição expirou ou não está mais disponível. |
| 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. |
| 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.