Criar palavras de legenda com marcação de tempo

POST https://api.voicecheap.ai/v1/actions/captions_transcribe

​

Autenticação e permissões

​

Parâmetros

{
  "type": "object",
  "properties": {
    "fileKey": {
      "type": "string",
      "minLength": 1,
      "maxLength": 1024,
      "description": "An owned fileKey returned by a completed upload or media import. Each generation consumes its uploaded source."
    },
    "fileName": {
      "type": "string",
      "minLength": 1,
      "maxLength": 255,
      "pattern": "^[^/\\\\\\r\\n\\0]+$"
    },
    "keyterms": {
      "maxItems": 100,
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1,
        "maxLength": 120
      }
    },
    "requestId": {
      "description": "UUID v4 for this action. Reuse the same ID with identical arguments on retries.",
      "type": "string",
      "format": "uuid",
      "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    }
  },
  "required": ["fileKey"],
  "additionalProperties": false
}

​

Idempotência

​

Exemplos de requisição

curl --request POST 'https://api.voicecheap.ai/v1/actions/captions_transcribe' \
  --header "x-api-key: $VOICECHEAP_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{"fileKey":"uploads/account-user/a1b2c3d4-e5f6-4789-8abc-def012345678-interview.wav","fileName":"interview.wav","keyterms":["VoiceCheap"],"requestId":"13579bdf-2468-4ace-8bdf-0123456789ab"}'

const input = {
  fileKey: 'uploads/account-user/a1b2c3d4-e5f6-4789-8abc-def012345678-interview.wav',
  fileName: 'interview.wav',
  keyterms: ['VoiceCheap'],
  requestId: '13579bdf-2468-4ace-8bdf-0123456789ab',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/captions_transcribe', {
  method: 'POST',
  headers: {
    'x-api-key': process.env.VOICECHEAP_API_KEY,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify(input),
});
const body = await response.json();
if (!response.ok) throw new Error(body.code + ': ' + body.message);
console.log(body);

import os
import requests

response = requests.post(
    "https://api.voicecheap.ai/v1/actions/captions_transcribe",
    headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
    json={"fileKey": "uploads/account-user/a1b2c3d4-e5f6-4789-8abc-def012345678-interview.wav", "fileName": "interview.wav", "keyterms": ["VoiceCheap"], "requestId": "13579bdf-2468-4ace-8bdf-0123456789ab"},
    timeout=120,
)
body = response.json()
if not response.ok:
    raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)

​

Resposta

{
  "data": {
    "requestId": "13579bdf-2468-4ace-8bdf-0123456789ab",
    "status": "running",
    "pollAction": "action_request_get",
    "pollAfterSeconds": 5
  },
  "requestId": "13579bdf-2468-4ace-8bdf-0123456789ab"
}

{
  "data": {
    "resultId": "b3caf96f-5f2a-4619-832c-a12c0d57f78b",
    "operation": "captions_transcribe",
    "createdAt": 1792152000000,
    "fileName": "voicecheap-captions_transcribe-b3caf96f-5f2a-4619-832c-a12c0d57f78b.json",
    "byteLength": 190,
    "contentType": "application/json; charset=utf-8",
    "status": "completed",
    "requestId": "13579bdf-2468-4ace-8bdf-0123456789ab",
    "getAction": "subtitles_result_get",
    "downloadAction": "subtitles_result_download",
    "listAction": "subtitles_result_list"
  },
  "requestId": "13579bdf-2468-4ace-8bdf-0123456789ab"
}

{
  "data": {
    "requestId": "13579bdf-2468-4ace-8bdf-0123456789ab",
    "operation": "captions_transcribe",
    "createdAt": 1792144800000,
    "updatedAt": 1792144820000,
    "status": "running",
    "pollAfterSeconds": 5
  },
  "requestId": "13579bdf-2468-4ace-8bdf-0123456789ab"
}

{
  "data": {
    "requestId": "13579bdf-2468-4ace-8bdf-0123456789ab",
    "operation": "captions_transcribe",
    "createdAt": 1792144800000,
    "updatedAt": 1792144820000,
    "status": "completed",
    "resultStored": false,
    "message": "The action completed. Retrieve its output from the corresponding history or resource action."
  },
  "requestId": "13579bdf-2468-4ace-8bdf-0123456789ab"
}

​

Campos do resultado

​

Recuperar e consultar esta requisição

curl --request POST 'https://api.voicecheap.ai/v1/actions/action_request_get' \
  --header "x-api-key: $VOICECHEAP_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{"requestId":"13579bdf-2468-4ace-8bdf-0123456789ab","operation":"captions_transcribe"}'

{
  "data": {
    "requestId": "13579bdf-2468-4ace-8bdf-0123456789ab",
    "operation": "captions_transcribe",
    "status": "completed",
    "createdAt": 1792144800000,
    "updatedAt": 1792144820000,
    "resultStored": true,
    "result": {
      "resultId": "b3caf96f-5f2a-4619-832c-a12c0d57f78b",
      "operation": "captions_transcribe",
      "createdAt": 1792152000000,
      "fileName": "voicecheap-captions_transcribe-b3caf96f-5f2a-4619-832c-a12c0d57f78b.json",
      "byteLength": 190,
      "contentType": "application/json; charset=utf-8",
      "status": "completed",
      "requestId": "13579bdf-2468-4ace-8bdf-0123456789ab",
      "getAction": "subtitles_result_get",
      "downloadAction": "subtitles_result_download",
      "listAction": "subtitles_result_list"
    }
  }
}

​

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.
• Use um requestId UUID v4 ou um cabeçalho Idempotency-Key idêntico e mantenha a mesma ação, ID e argumentos nas novas tentativas. Uma repetição em cache não usa outra chamada mensal.
• Esta é uma ação assíncrona. O resultado inicial do transporte é uma requisição running com pollAction; consulte action_request_get periodicamente com esta operação e o requestId original. O resultado da operação concluída mostrado aqui é uma referência compacta à saída salva, não o corpo gerado.
• A saída completa é salva sob a propriedade autenticada em armazenamento criptografado, independentemente do cache limitado de consulta de ações. Chame o getAction retornado com resultId e includeContent: true para obter JSON estruturado, ou downloadAction com resultId para obter texto JSON. listAction oferece uma forma de recuperação quando apenas a requisição original é conhecida.
• O JSON salvo é limitado a 32 MiB. Os metadados nunca expõem sua chave de criptografia do armazenamento nem uma URL não autenticada de download da transcrição.
• Uma geração bem-sucedida confirma o uso de uma unidade da cota pessoal da ferramenta. Uma geração com falha normalmente libera a reserva da ferramenta. Quando a persistência da saída é incerta, inspecione a mesma requisição e o histórico de resultados salvos antes de gerar novamente; o servidor mantém a reserva para impedir uso duplicado.
• Os planos superiores sem teto mensal de integração ainda têm as cotas diárias específicas de cada ferramenta e os limites de mídia abaixo. Essas ações independentes usam a cota da ferramenta em vez de minutos de dublagem ou caracteres TTS.
• Use fileKey de um envio ou importação concluído que lhe pertence e trate-o como de uso único. Quando o processamento de mídia começa, a limpeza exclui a origem após o sucesso ou uma falha de processamento. Uma rejeição de validação ou de cota antes do processamento pode deixá-la intacta. Reutilize o requestId original para recuperar a geração aceita antes de iniciar outra.
• Envie apenas a faixa de áudio extraída: WAV, MP3, M4A, AAC, OGG, Opus ou FLAC, com no máximo 250 MiB. Um arquivo com fluxo de vídeo é rejeitado mesmo quando o nome tem uma extensão de áudio.
• Beginner aceita até 30 minutos; Starter, Creator, Pro, Scale e Enterprise aceitam até 60 minutos, com mais 2 segundos de tolerância do contêiner.
• Limite diário de transcrição de legendas: Beginner 10, Starter 15, Creator 30, Pro 60, Scale 100 e Enterprise 100; compartilhado com a ferramenta de legendas da web.
• Os deslocamentos das palavras são em milissegundos; durationSeconds é em segundos. O servidor retorna palavras com marcação de tempo, não um vídeo animado renderizado. A edição e a renderização locais de legendas no navegador estão fora desta ação.
• A transcrição de legendas não tem uma família separada de ações de histórico web. Use subtitles_result_list/get/download para recuperar sua saída de integração completa.

​

Uso

​

Erros

{
  "code": "INSUFFICIENT_SCOPE",
  "message": "This credential does not permit the requested action.",
  "status": 403,
  "details": {
    "requiredScopes": ["subtitles:write"]
  }
}