Skip to main content

Referência da API

A API VoiceCheap é organizada em torno dos princípios REST. Ela utiliza métodos HTTP padrão, retorna respostas codificadas em JSON e usa códigos de resposta HTTP padrão.

URL Base

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

Autenticação

Todas as solicitações exigem uma chave de API passada no cabeçalho x-api-key. Consulte a página Autenticação para obter detalhes.

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.

Endpoints Disponíveis

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.

Iniciar Tradução

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

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

Todas as respostas bem-sucedidas seguem esta estrutura geral:
As respostas de erro seguem esta estrutura:

Códigos de Status HTTP