Skip to main content
POST
Leia os metadados da sua saída salva. Defina includeContent=true para recuperar o JSON estruturado completo, incluindo todas as palavras de legenda ou o texto da transcrição.

Autenticação e permissões

string
obrigatório
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: subtitles:read. É 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

string
obrigatório
Valor de texto.Formato: “uuid”. Padrão: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$.
boolean
Valor booleano.Valor padrão: false.
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.

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.

Resposta

Uma primeira execução bem-sucedida retorna HTTP 200 com o resultado da operação em data. Uma repetição pode retornar o estado salvo da requisição. O exemplo mostra uma resposta aceita, não todos os campos opcionais. Metadados da saída salva, mais o resultado estruturado completo quando includeContent é true. Omitir includeContent retorna apenas os metadados.

Campos do resultado

Notas da operação

  • Requer uma assinatura paga e a permissão da ação. O plano pessoal de ferramentas do usuário executor é verificado novamente na execução; as ferramentas salvas e as referências de envio pertencem a esse usuário, inclusive quando a credencial está associada a uma equipe.
  • Uma ação bem-sucedida usa uma chamada mensal compartilhada de API/MCP. Beginner permite 500, Starter 5,000 e Creator 25,000 chamadas/mês; Pro, Scale e Enterprise não têm teto mensal. Os limites por minuto ainda se aplicam: 30, 60, 120, 180, 300 e 600, respectivamente. As cotas de geração das ferramentas são separadas.
  • resultId é um UUID de uma referência de geração concluída ou do result_list deste domínio. Ele é diferente do requestId da ação e do historyId da ferramenta da web.
  • Os resultados pertencem ao ator autenticado e ao domínio de permissão. Um resultado de subtitles não pode ser lido por ações de transcription, ou vice-versa.
  • O JSON completo salvo é criptografado em repouso e mantido independentemente do cache limitado de consultas periódicas da ação. A recuperação continua autenticada; nenhuma URL pública de JSON de transcrição ou legendas é emitida.
  • Estas ações recuperam saídas existentes e não geram mídia nem usam uma cota diária. Cada recuperação bem-sucedida ainda usa uma chamada mensal de integração.
  • Metadados pending significam que a persistência da saída precisa de recuperação. Ler o conteúdo ou baixá-lo tenta recuperar um objeto criptografado já salvo; verifique-o antes de iniciar outra geração.
  • O padrão de includeContent é false. true descriptografa e retorna o JSON gerado completo em result. Este exemplo mostra a forma que retorna o conteúdo.
  • A estrutura do resultado aninhado segue sua operação original. Saídas de transcrição contêm texto transcrito, saídas de legendas podem conter dados SRT/vídeo renderizado e as legendas contêm o texto das palavras, startMs/endMs, speakerId anulável e durationSeconds.

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