Iniciar um envio de mídia (legendas)

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

​

Autenticação e permissões

​

Parâmetros

{
  "type": "object",
  "properties": {
    "filename": {
      "type": "string",
      "minLength": 1,
      "maxLength": 255,
      "pattern": "^[^/\\\\\\r\\n\\0]+$"
    },
    "contentType": {
      "type": "string",
      "minLength": 1,
      "maxLength": 120,
      "pattern": "^(audio|video)\\/[A-Za-z0-9.+-]+$|^application\\/octet-stream$"
    },
    "fileSize": {
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 64424509440
    },
    "kind": {
      "type": "string",
      "enum": ["transcription", "video_to_srt", "add_subtitles", "animated_captions", "project"]
    },
    "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": ["filename", "contentType", "fileSize", "kind"],
  "additionalProperties": false
}

​

Idempotência

​

Exemplos de requisição

curl --request POST 'https://api.voicecheap.ai/v1/actions/subtitles_upload_initialize' \
  --header "x-api-key: $VOICECHEAP_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{"filename":"interview.mp4","contentType":"video/mp4","fileSize":1048576,"kind":"video_to_srt","requestId":"13579bdf-2468-4ace-8bdf-0123456789ab"}'

const input = {
  filename: 'interview.mp4',
  contentType: 'video/mp4',
  fileSize: 1048576,
  kind: 'video_to_srt',
  requestId: '13579bdf-2468-4ace-8bdf-0123456789ab',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/subtitles_upload_initialize', {
  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_upload_initialize",
    headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
    json={"filename": "interview.mp4", "contentType": "video/mp4", "fileSize": 1048576, "kind": "video_to_srt", "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": {
    "uploadId": "a1b2c3d4-e5f6-4789-8abc-def012345678",
    "key": "uploads/account-user/a1b2c3d4-e5f6-4789-8abc-def012345678-interview.mp4",
    "partSize": 5242880,
    "maxConcurrency": 4
  },
  "requestId": "13579bdf-2468-4ace-8bdf-0123456789ab"
}

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

{
  "data": {
    "requestId": "13579bdf-2468-4ace-8bdf-0123456789ab",
    "operation": "subtitles_upload_initialize",
    "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":"subtitles_upload_initialize"}'

{
  "data": {
    "requestId": "13579bdf-2468-4ace-8bdf-0123456789ab",
    "operation": "subtitles_upload_initialize",
    "status": "completed",
    "createdAt": 1792144800000,
    "updatedAt": 1792144820000,
    "resultStored": true,
    "result": {
      "uploadId": "a1b2c3d4-e5f6-4789-8abc-def012345678",
      "key": "uploads/account-user/a1b2c3d4-e5f6-4789-8abc-def012345678-interview.mp4",
      "partSize": 5242880,
      "maxConcurrency": 4
    }
  }
}

​

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.
• O prefixo de upload seleciona a permissão necessária. tools usa transcription:write, subtitles usa subtitles:write, projects usa projects:write e voices usa voices:write.
• Para ferramentas, legendas e projetos, kind aceita transcription, video_to_srt, add_subtitles, animated_captions ou project. O kind selecionado determina os limites do fluxo de trabalho; o prefixo não impõe um kind.
• O kind escolhido aplica seus próprios limites: transcription 200 MiB; video_to_srt e add_subtitles 300 MiB; animated_captions 250 MiB e somente áudio; project usa o limite de upload do plano (Beginner 5 GiB, Starter 10 GiB, Creator 20 GiB, Pro 30 GiB, Scale 40 GiB, Enterprise 60 GiB). Mídias independentes têm no máximo 2 horas. As legendas permitem 30 minutos no Beginner e 60 minutos nos planos públicos superiores, mais uma tolerância de 2 segundos no contêiner. A duração do projeto é de no máximo 2 horas, ou 3 horas no Enterprise.
• O nome do arquivo de entrada deve ser um único nome de arquivo, sem barras, barras invertidas, CR, LF ou NUL. O contentType deve ser um tipo MIME de áudio/vídeo compatível ou application/octet-stream para uploads que não sejam de voz.
• A inicialização retorna key, não fileKey. Mantenha uploadId separadamente; ele é o UUID usado para assinatura, conclusão e aborto.
• partSize é selecionado entre 5 MiB e 100 MiB. Calcule o número de partes como ceil(fileSize / partSize), use no máximo maxConcurrency PUTs simultâneos e guarde cada ETag retornado.
• As sessões de upload expiram após 24 horas. Preparar o upload não consome a cota diária de geração.

​

Uso

​

Erros

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