> ## Documentation Index > Fetch the complete documentation index at: https://api-docs.voicecheap.ai/docs/llms.txt > Use this file to discover all available pages before exploring further. # Iniciar um envio de mídia (legendas) > Inicie um envio em várias partes que lhe pertence. Envie cada parte para sua URL assinada e conclua o envio antes de chamar uma ação de geração. Inicie um envio em várias partes que lhe pertence. Envie cada parte para sua URL assinada e conclua o envio antes de chamar uma ação de geração. ```http theme={null} POST https://api.voicecheap.ai/v1/actions/subtitles_upload_initialize ``` ## Autenticação e permissões 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:write`. É 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 Valor de texto. Comprimento mínimo: 1. Comprimento máximo: 255. Padrão: `^[^/\\\r\n\0]+$`. Valor de texto. Comprimento mínimo: 1. Comprimento máximo: 120. Padrão: `^(audio|video)\/[A-Za-z0-9.+-]+$|^application\/octet-stream$`. Valor inteiro. Máximo: 64424509440. Valor de texto. Valores aceitos: "transcription", "video\_to\_srt", "add\_subtitles", "animated\_captions", "project". Opcional na camada de transporte: o servidor insere um identificador antes da validação quando ele é omitido. Forneça seu próprio UUID v4 estável para recuperar com segurança uma resposta perdida. Formato: "uuid". Padrão: `^[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}$`. 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. ```json theme={null} { "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 Use um UUID v4 em requestId ou no cabeçalho HTTP Idempotency-Key para cada alteração. Reutilize o mesmo identificador e argumentos idênticos após uma falha de rede. Se ambos forem fornecidos, devem ser iguais. Repetir uma requisição salva não repete a operação nem consome outra chamada mensal. Requisições com falha ou interrompidas não são reiniciadas automaticamente. Qualquer alteração pode retornar HTTP 202 quando uma nova tentativa encontra a mesma requisição ainda em execução, mesmo que a primeira execução normalmente seja síncrona. Se a execução foi concluída, mas resultStored é false, uma nova tentativa retorna HTTP 200 com o estado salvo da requisição em vez do resultado original. Recupere a saída pela ação de histórico, resultado ou download do domínio correspondente. ## 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. ```bash cURL theme={null} 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"}' ``` ```javascript JavaScript theme={null} 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); ``` ```python Python theme={null} 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 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. Uma sessão de upload multipart pertencente ao usuário. key é uma referência de armazenamento; conclua todas as partes antes de usá-la como fileKey de geração. ```json HTTP 200 theme={null} { "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" } ``` ```json HTTP 202 replay_running theme={null} { "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" } ``` ```json HTTP 200 replay_completed_without_result theme={null} { "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 | Campo | Descrição | | - | - | | `data.uploadId` | UUID opaco da sessão de envio ativa; use-o sem alterações nas ações multipart subsequentes. | | `data.key` | Chave de armazenamento pertencente ao usuário executor. Uma geração deve aguardar upload\_complete. | | `data.partSize` | Tamanho em bytes de cada parte, exceto a última. | | `data.maxConcurrency` | Número máximo recomendado de partes enviadas simultaneamente. | ## Recuperar e consultar esta requisição Use o mesmo identificador mesmo após perder a conexão. Se resultStored for false, recupere a saída pela ação correspondente de histórico, resultado ou download. Nunca inicie uma segunda geração apenas para verificar o progresso. ```bash theme={null} 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"}' ``` ```json HTTP 200 theme={null} { "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 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 | Status HTTP | Código | Significado ou recuperação | | - | - | - | | 400 | `BAD_REQUEST` | Para kind: project, o fileSize declarado excede o limite de upload do plano do ator. | | 400 | `CREDENTIAL_IN_QUERY` | Foram fornecidas credenciais em um parâmetro de consulta access\_token ou api\_key. Envie as credenciais nos cabeçalhos. | | 400 | `FILE_TOO_LARGE` | O fileSize declarado excede o limite de upload da ferramenta independente de mídia selecionada. | | 400 | `IDEMPOTENCY_CONFLICT` | Os IDs de requisição do cabeçalho e do corpo são diferentes. | | 400 | `INVALID_FILE_TYPE` | O tipo de ferramenta selecionado não aceita o nome do arquivo e o tipo de mídia; animated\_captions exige uma extensão de áudio. | | 400 | `INVALID_REQUEST_ID` | requestId ou Idempotency-Key não é um UUID v4. | | 400 | `VALIDATION_ERROR` | Os argumentos não atendem ao esquema da ação ou um argumento desconhecido foi fornecido. | | 401 | `API_KEY_EXPIRED` | A chave de API expirou. | | 401 | `INVALID_API_KEY` | Forneça uma chave de API válida e dentro do prazo de validade. | | 401 | `INVALID_CREDENTIAL` | O cabeçalho Authorization está malformado ou entra em conflito com x-api-key. | | 401 | `MISSING_CREDENTIAL` | Nenhuma credencial utilizável foi fornecida no cabeçalho, ou ela excedeu 4096 caracteres. | | 401 | `USER_NOT_FOUND` | A conta da credencial não existe mais. | | 403 | `ACCOUNT_UNAVAILABLE` | A conta que executa a ação ou a conta de cobrança está indisponível ou em processo de exclusão. | | 403 | `AMBIGUOUS_TEAM_API_KEY` | O usuário da credencial pertence a mais de uma equipe, portanto o contexto de cobrança é ambíguo. | | 403 | `INSUFFICIENT_SCOPE` | A chave de API ou a conexão MCP não tem a permissão necessária para a ação. | | 403 | `INTEGRATION_PLAN_UNSUPPORTED` | Não foi possível verificar os limites de integração da conta. | | 403 | `PAID_SUBSCRIPTION_REQUIRED` | O ator autenticado não tem mais uma assinatura paga quando esta ação da ferramenta é executada. | | 403 | `SUBSCRIPTION_REQUIRED` | Use uma assinatura paga ativa. | | 403 | `TEAM_OWNER_NOT_FOUND` | Não foi possível encontrar a conta efetiva do proprietário da equipe. | | 409 | `CONCURRENT_ACTION_LIMIT_REACHED` | Esta conta já tem 10 ações de integração em execução. Consulte uma requisição existente antes de iniciar outra. | | 409 | `IDEMPOTENCY_CONFLICT` | Reutilize um identificador apenas com a mesma operação e os mesmos argumentos. | | 429 | `INTEGRATION_MONTHLY_LIMIT_REACHED` | As chamadas usadas e pendentes atingiram a cota mensal compartilhada de API/MCP. | | 429 | `INTEGRATION_RATE_LIMIT_REACHED` | A conta atingiu seu limite de integração por minuto; inspecione retryAfterSeconds. | | 500 | `INTERNAL_ERROR` | Verifique o estado da requisição salva e o histórico do recurso antes de decidir repetir uma alteração. | | 503 | `ACTION_RESULT_UNAVAILABLE` | A ação foi executada, mas não foi possível confirmar a persistência do resultado da requisição. Consulte periodicamente a mesma ação e requestId e inspecione o histórico do recurso antes de iniciar outra gravação. | | 503 | `INTERNAL_ERROR` | A inicialização do upload ou o armazenamento durável da sessão está indisponível. | | 503 | `SERVER_RESTARTING` | O servidor está reiniciando. Tente novamente em breve e mantenha o mesmo identificador de requisição para uma alteração. | ```json theme={null} { "code": "INSUFFICIENT_SCOPE", "message": "This credential does not permit the requested action.", "status": 403, "details": { "requiredScopes": ["subtitles:write"] } } ``` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.