Skip to main content

​
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. Esses fluxos também estão disponíveis pelo servidor MCP da conta, exceto a criação e a rotação do segredo de assinatura dos webhooks, que exigem REST. Gerencie credenciais em Integrações e consulte os limites de uso.

​
URL Base

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

​
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 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:
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 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 ou descubra as ações e os esquemas permitidos para a sua chave. 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

Transcrever Mídia

POST /v1/transcribeTranscreva um arquivo enviado como JSON, SRT ou VTT.

Exportar Transcrição do Projeto

POST /v1/projects/{projectId}/transcriptRecupere transcrições de projeto originais ou traduzidas.

Criar projeto

POST /v1/projectsEnvie um arquivo de vídeo ou áudio e inicie apenas a transcrição.

Iniciar Tradução

POST /v1/translateEnvie um arquivo de vídeo ou áudio e inicie um projeto de tradução.

Dublar projeto

POST /v1/projects/{projectId}/dubDuble um projeto transcrito usando seu próprio arquivo SRT traduzido.

Obter Status da Tradução

GET /v1/translate/{projectId}/statusVerifique o status de um projeto de tradução e recupere os resultados.

Obter Detalhes do Projeto

GET /v1/projects/{projectId}Recupere o histórico da versão traduzida, o histórico de sincronização labial e o estado do projeto.

Excluir Projeto

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

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

​
Códigos de Status HTTP