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

# Referência da API

> Referência completa para a API REST VoiceCheap

# Referência da API

A API VoiceCheap usa métodos e códigos de status HTTP padrão. A maioria dos endpoints retorna JSON; as exportações de transcrição também podem retornar SRT ou VTT.

Para configurações da conta, gestão da equipe, ferramentas de mídia e outros fluxos de trabalho, use o [catálogo de ações](https://api-docs.voicecheap.ai/docs/pt/api-reference/actions.md). Esses fluxos também estão disponíveis pelo [servidor MCP da conta](https://api-docs.voicecheap.ai/docs/pt/ai/model-context-protocol.md), exceto a criação e a rotação do segredo de assinatura dos webhooks, que exigem REST. Gerencie credenciais em [Integrações](https://api-docs.voicecheap.ai/docs/pt/ai/integrations.md) e consulte os [limites de uso](https://api-docs.voicecheap.ai/docs/pt/api-reference/limits.md).

## URL Base

Todas as solicitações da API devem ser feitas para:

```text theme={null}
https://api.voicecheap.ai
```

## Autenticação

Autentique chamadas REST privadas com uma chave de API em `x-api-key` ou `Authorization: Bearer`. O documento OpenAPI é público. Consulte [Autenticação](https://api-docs.voicecheap.ai/docs/pt/authentication.md) para saber mais sobre credenciais com permissões específicas e OAuth para MCP.

## API de ações JSON

As secções de conta, equipa, projetos, vozes e ferramentas multimédia documentam cada ação JSON separadamente. Todas estas rotas usam `POST`, incluindo para consultar e eliminar; envie os argumentos no corpo JSON. As rotas de carregamento de ficheiros e de projetos existentes abaixo mantêm os seus próprios métodos HTTP.

Crie uma chave API com `account:read`, defina a variável de ambiente `VOICECHEAP_API_KEY` e experimente este pedido só de leitura:

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

Uma ação concluída devolve HTTP 200 com o resultado em `data`. Uma ação demorada devolve HTTP 202 e um `requestId`; consulte o [estado do pedido](https://api-docs.voicecheap.ai/docs/pt/api-reference/actions/requests/action-request-get.md) para recuperar o resultado. Uma tarefa multimédia pode continuar após a conclusão do pedido de ação.

Consulte [todas as ações por área](https://api-docs.voicecheap.ai/docs/pt/api-reference/actions.md) ou [descubra as ações e os esquemas permitidos para a sua chave](https://api-docs.voicecheap.ai/docs/pt/api-reference/discovery/actions-list.md). Cada página indica permissões, parâmetros, exemplos e erros.

## Tipos de Conteúdo

* **Solicitação**: Use `multipart/form-data` para uploads de arquivos, `application/json` para outras solicitações
* **Resposta**: Endpoints JSON retornam `application/json`. Exportações de transcrição também podem retornar texto SRT ou VTT.

## Carregamento de ficheiros e rotas de projetos existentes

> [card] [Transcrever Mídia](https://api-docs.voicecheap.ai/docs/pt/api-reference/transcribe.md)
>
> `POST /v1/transcribe`
>
> Transcreva um arquivo enviado como JSON, SRT ou VTT.

> [card] [Exportar Transcrição do Projeto](https://api-docs.voicecheap.ai/docs/pt/api-reference/project-transcript.md)
>
> `POST /v1/projects/{projectId}/transcript`
>
> Recupere transcrições de projeto originais ou traduzidas.

> [card] [Criar projeto](https://api-docs.voicecheap.ai/docs/pt/api-reference/create-project.md)
>
> `POST /v1/projects`
>
> Envie um arquivo de vídeo ou áudio e inicie apenas a transcrição.

> [card] [Iniciar Tradução](https://api-docs.voicecheap.ai/docs/pt/api-reference/translate.md)
>
> `POST /v1/translate`
>
> Envie um arquivo de vídeo ou áudio e inicie um projeto de tradução.

> [card] [Dublar projeto](https://api-docs.voicecheap.ai/docs/pt/api-reference/dub-project.md)
>
> `POST /v1/projects/{projectId}/dub`
>
> Duble um projeto transcrito usando seu próprio arquivo SRT traduzido.

> [card] [Obter Status da Tradução](https://api-docs.voicecheap.ai/docs/pt/api-reference/translation-status.md)
>
> `GET /v1/translate/{projectId}/status`
>
> Verifique o status de um projeto de tradução e recupere os resultados.

> [card] [Obter Detalhes do Projeto](https://api-docs.voicecheap.ai/docs/pt/api-reference/project-details.md)
>
> `GET /v1/projects/{projectId}`
>
> Recupere o histórico da versão traduzida, o histórico de sincronização labial e o estado do projeto.

> [card] [Excluir Projeto](https://api-docs.voicecheap.ai/docs/pt/api-reference/delete-project.md)
>
> `DELETE /v1/translate/{projectId}`
>
> Exclua permanentemente um projeto de tradução e seus ativos.

## Fluxo de Trabalho de Tradução

O fluxo de trabalho típico para traduzir um vídeo é:

```mermaid theme={null}
sequenceDiagram
    participant Client as Cliente
    participant API
    participant Processing as Processamento

    Client->>API: POST /v1/translate (arquivo + opções)
    API->>Processing: Colocar tradução na fila
    API-->>Client: 201 (projectId)

    loop Consultar o status
        Client->>API: GET /v1/translate/{projectId}/status
        API-->>Client: status (processing/success/failed)
    end

    Note over Client: Baixar a URL do vídeo traduzido quando o status for "success"
```

## Formato de Resposta

As rotas existentes de ficheiros e projetos abaixo mantêm os seus formatos de resposta específicos.

Os campos de uma resposta bem-sucedida dependem do endpoint. A criação de um projeto e o início da dublagem retornam `success`, `message` e `projectId`. As consultas de status e detalhes retornam o estado do projeto; as solicitações de transcrição retornam JSON, SRT ou VTT. Consulte a página de cada endpoint para ver os campos exatos.

Os erros retornam um objeto JSON com `code` e `message`, às vezes também com `details`. Consulte [Códigos de erro](https://api-docs.voicecheap.ai/docs/pt/api-reference/errors.md).

## Códigos de Status HTTP

| Código de Status | Descrição |
| - | - |
| 200 | Sucesso |
| 201 | Criado - Um projeto ou uma dublagem foi iniciado |
| 202 | Aceite - Acompanhe a ação assíncrona com o respetivo identificador de pedido |
| 400 | Solicitação Inválida - Parâmetros inválidos |
| 401 | Não Autorizado - Chave de API inválida ou ausente |
| 403 | Proibido - Permissões ou créditos insuficientes |
| 404 | Não Encontrado - O recurso não existe |
| 409 | Conflito - O estado do projeto não permite a solicitação |
| 413 | Arquivo grande demais - O upload excede o limite |
| 429 | Muitas Solicitações - Limite de taxa excedido |
| 500 | Erro Interno do Servidor |
| 502 | Erro de processamento - Não foi possível concluir a transcrição |
| 503 | Serviço temporariamente indisponível - Mantenha o identificador e consulte o estado antes de tentar novamente |


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