Integração API

Sua primeira transcrição

A transcrição acontece em segundo plano. A criação de uma tarefa retorna uma resposta imediata; consulte o status até que o resultado esteja pronto.

1. 1

   Criar uma tarefa

   Envie POST /transcripts com uma URL de mídia direta e pública. Guarde o id retornado.

2. 2

   Consultar o progresso

   Consulte GET /transcripts/{id} a cada 15–30 segundos até que status seja complete ou error.

3. 3

   Usar sua transcrição

   Leia o JSON em data ou baixe o arquivo de export_url ao solicitar SRT ou VTT.

Status da tarefa

Considere qualquer outro status como ainda em andamento. Novos estados intermediários podem ser adicionados.

Autenticação

Envie sua chave de API no cabeçalho Authorization de cada requisição, exatamente como foi exibida ao criá-la.

Authorization: <your api key>

Não adicione o prefixo Bearer.

As novas chaves começam com tp_live_. A chave completa é exibida apenas uma vez, ao criá-la. Se você a perder, revogue-a e crie uma nova; uma chave revogada para de funcionar imediatamente.

É necessária uma assinatura ativa e uma chave de API com as permissões exigidas.

Criar uma transcrição

Inicie uma tarefa de transcrição para um arquivo de mídia em uma URL pública. A resposta é retornada assim que a tarefa entra na fila, com status: "initializing".

O Taption baixa o arquivo diretamente. Links de páginas de compartilhamento, como uma prévia do Google Drive ou Dropbox, não funcionam.

media_urlstringobrigatório

Link de download direto do seu arquivo de mídia.

Máximo de 2048 caracteres

extensionstringobrigatório

O formato do arquivo de mídia.

mp3wavm4aaacflacwmaopusmp4

languagestringobrigatório

Idioma falado na mídia, como uma tag de idioma. Consulte a referência de idiomas.

Ver tags de idioma

namestring

Nome de exibição da transcrição. Por padrão, é usado o nome do arquivo em `media_url`. Nomes mais longos são cortados em 200 caracteres.

Máximo de 200 caracteres

export_typestring

Formato de saída. O padrão é json, que retorna o conteúdo da transcrição já interpretado em data. srt e vtt retornam um link de arquivo em export_url.

jsonsrtvtt

Padrão: json

max_charinteger

Máximo de caracteres por segmento de legenda. O padrão é `16` para chinês, japonês, coreano e cantonês, e `65` para outros idiomas. Valores fora de 1–200 são ignorados e o padrão é usado.

1–200

Respostas

Obter uma transcrição

Obtenha o status atual e o resultado de uma transcrição. Consulte a cada 15–30 segundos enquanto a tarefa estiver em andamento.

Com json ou sem especificar o tipo de exportação, o resultado final aparece em data. Com srt ou vtt, baixe o arquivo de export_url.

idstringobrigatório

O ID da transcrição retornado por POST /transcripts.Máximo de 256 caracteres

Respostas

O objeto de transcrição

As requisições de criação e consulta de status retornam um objeto JSON. Seus campos descrevem a tarefa e, quando estiver pronto, seu resultado.

idstring

O ID da transcrição. Use-o com `GET /transcripts/{id}`.

statusstring

Status da tarefa: `initializing`, `transcribing`, `complete` ou `error`. Considere qualquer outro valor como ainda em andamento.

dataJSON

Exportação JSON já interpretada quando pronta para json ou se export_type for omitido; caso contrário, uma string vazia.

export_urlstring

Link de download de uma exportação srt ou vtt. Vazio até que esteja pronta. Omitido das respostas de status para json ou se export_type for omitido.

messagestring

Detalhes adicionais do status atual. Durante `transcribing`, pode indicar uma etapa como `ANALYZING` ou `FINALIZING`. Quando `status` é `error`, descreve a falha. Destinado à leitura por pessoas; não o interprete por código.

error_codestring

Código opcional legível por máquina para um erro de limite de envio.

limitinteger

Limite aplicável à conta, incluído nas respostas HTTP 429.

Erros e novas tentativas

Use o código de status HTTP para decidir o próximo passo. O campo message é destinado à leitura por pessoas; sua redação pode mudar.

As respostas da API incluem o cabeçalho X-Request-Id. Informe-o ao entrar em contato com o suporte sobre uma requisição.