Skip to main content
POST
Exporte o texto de transcrição salvo como texto bruto, parágrafos ou frases.

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: transcription: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.Comprimento mínimo: 1. Comprimento máximo: 160. Padrão: ^[A-Za-z0-9_-]+$.
string
Valor de texto.Valores aceitos: “raw”, “paragraphs”, “sentences”. Valor padrão: “paragraphs”.
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. Texto exportado da transcrição salva, com um nome de arquivo .txt sanitizado e um tipo MIME de texto.

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.
  • format aceita raw, paragraphs ou sentences, e seu padrão é paragraphs. O conteúdo é obtido da variante correspondente da transcrição salva.
  • Retorna texto dentro de JSON. Salve a string content com o fileName retornado; esta ação não retorna mídia binária nem uma URL pública de transcrição.
  • O nome do arquivo de saída é sanitizado a partir do nome da origem salvo e limitado a um nome-base de 180 caracteres. A exportação lê o histórico existente e não consome um upload de origem nem a cota diária da ferramenta.

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