Exportar o resultado salvo de uma ação de legendas

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

​

Autenticação e permissões

​

Parâmetros

{
  "type": "object",
  "properties": {
    "resultId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([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)$"
    }
  },
  "required": ["resultId"],
  "additionalProperties": false
}

​

Exemplos de requisição

curl --request POST 'https://api.voicecheap.ai/v1/actions/subtitles_result_download' \
  --header "x-api-key: $VOICECHEAP_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{"resultId":"b3caf96f-5f2a-4619-832c-a12c0d57f78b"}'

const input = {
  resultId: 'b3caf96f-5f2a-4619-832c-a12c0d57f78b',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/subtitles_result_download', {
  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/subtitles_result_download",
    headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
    json={"resultId": "b3caf96f-5f2a-4619-832c-a12c0d57f78b"},
    timeout=120,
)
body = response.json()
if not response.ok:
    raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)

​

Resposta

{
  "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",
    "content": "{\"words\":[{\"text\":\"Hello\",\"startMs\":0,\"endMs\":500,\"speakerId\":\"speaker_0\"},{\"text\":\"world.\",\"startMs\":500,\"endMs\":1500,\"speakerId\":\"speaker_0\"}],\"detectedLanguage\":\"en\",\"durationSeconds\":60}"
  }
}

​

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.
• Grave content em fileName usando UTF-8 ou use JSON.parse(content) para recuperar a saída estruturada. A resposta externa não contém uma propriedade result nem uma URL de download de mídia.
• byteLength descreve o JSON UTF-8 dentro de content; contentType é application/json; charset=utf-8. O download também tenta recuperar a saída criptografada pendente.

​

Uso

​

Erros

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