curl --request POST 'https://api.voicecheap.ai/v1/actions/subtitles_upload_import' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"url":"https://media.example.com/interview.mp4","filename":"interview.mp4","kind":"video_to_srt","requestId":"13579bdf-2468-4ace-8bdf-0123456789ab"}'
const input = {
url: 'https://media.example.com/interview.mp4',
filename: 'interview.mp4',
kind: 'video_to_srt',
requestId: '13579bdf-2468-4ace-8bdf-0123456789ab',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/subtitles_upload_import', {
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_import",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"url": "https://media.example.com/interview.mp4", "filename": "interview.mp4", "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)
{
"data": {
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab",
"status": "running",
"pollAction": "action_request_get",
"pollAfterSeconds": 5
},
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab"
}
{
"data": {
"fileKey": "uploads/account-user/a1b2c3d4-e5f6-4789-8abc-def012345678-interview.mp4",
"fileName": "interview.mp4",
"fileSize": 1048576,
"durationSeconds": 60,
"mimeType": "video/mp4",
"uploadType": "video",
"readUrl": "https://media.example.com/uploads/account-user/a1b2c3d4-e5f6-4789-8abc-def012345678-interview.mp4"
},
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab"
}
{
"data": {
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab",
"operation": "subtitles_upload_import",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "running",
"pollAfterSeconds": 5
},
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab"
}
{
"data": {
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab",
"operation": "subtitles_upload_import",
"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"
}
Legendas
Importar mídia de uma URL (legendas)
Importe uma URL pública HTTPS direta de áudio ou vídeo para sua conta. Redirecionamentos e redes privadas são recusados; aplicam-se os limites de arquivo e duração. Use o fileKey resultante em uma ação de geração.
POST
/
v1
/
actions
/
subtitles_upload_import
curl --request POST 'https://api.voicecheap.ai/v1/actions/subtitles_upload_import' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"url":"https://media.example.com/interview.mp4","filename":"interview.mp4","kind":"video_to_srt","requestId":"13579bdf-2468-4ace-8bdf-0123456789ab"}'
const input = {
url: 'https://media.example.com/interview.mp4',
filename: 'interview.mp4',
kind: 'video_to_srt',
requestId: '13579bdf-2468-4ace-8bdf-0123456789ab',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/subtitles_upload_import', {
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_import",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"url": "https://media.example.com/interview.mp4", "filename": "interview.mp4", "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)
{
"data": {
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab",
"status": "running",
"pollAction": "action_request_get",
"pollAfterSeconds": 5
},
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab"
}
{
"data": {
"fileKey": "uploads/account-user/a1b2c3d4-e5f6-4789-8abc-def012345678-interview.mp4",
"fileName": "interview.mp4",
"fileSize": 1048576,
"durationSeconds": 60,
"mimeType": "video/mp4",
"uploadType": "video",
"readUrl": "https://media.example.com/uploads/account-user/a1b2c3d4-e5f6-4789-8abc-def012345678-interview.mp4"
},
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab"
}
{
"data": {
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab",
"operation": "subtitles_upload_import",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "running",
"pollAfterSeconds": 5
},
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab"
}
{
"data": {
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab",
"operation": "subtitles_upload_import",
"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"
}
Importe uma URL pública HTTPS direta de áudio ou vídeo para sua conta. Redirecionamentos e redes privadas são recusados; aplicam-se os limites de arquivo e duração. Use o fileKey resultante em uma ação de geração.
Permissões necessárias:
POST https://api.voicecheap.ai/v1/actions/subtitles_upload_import
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.
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
string
obrigatório
Valor de texto.Comprimento máximo: 4096. Formato: “uri”.
string
Valor de texto.Comprimento mínimo: 1. Comprimento máximo: 255. Padrão:
^[^/\\\r\n\0]+$.string
obrigatório
Valor de texto.Valores aceitos: “transcription”, “video_to_srt”, “add_subtitles”, “animated_captions”, “project”.
string
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}$.Esquema de entrada completo
Esquema de entrada completo
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.
{
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 4096,
"format": "uri"
},
"filename": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"pattern": "^[^/\\\\\\r\\n\\0]+$"
},
"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": ["url", "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.curl --request POST 'https://api.voicecheap.ai/v1/actions/subtitles_upload_import' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"url":"https://media.example.com/interview.mp4","filename":"interview.mp4","kind":"video_to_srt","requestId":"13579bdf-2468-4ace-8bdf-0123456789ab"}'
const input = {
url: 'https://media.example.com/interview.mp4',
filename: 'interview.mp4',
kind: 'video_to_srt',
requestId: '13579bdf-2468-4ace-8bdf-0123456789ab',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/subtitles_upload_import', {
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_import",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"url": "https://media.example.com/interview.mp4", "filename": "interview.mp4", "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
Esta operação retorna HTTP 202 enquanto está em execução. Salve requestId e consulte action_request_get com esse identificador e o nome da operação original. Os estados de consulta são running, completed, failed e interrupted. Um resultado concluído pode apontar para um processamento de mídia separado; continue com a ação de status ou de saída específica da operação. Uma referência de mídia importada pertencente ao ator com tamanho, duração, tipo de mídia e URL de leitura validados. Esta é a saída da ação concluída, após as consultas de status.{
"data": {
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab",
"status": "running",
"pollAction": "action_request_get",
"pollAfterSeconds": 5
},
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab"
}
{
"data": {
"fileKey": "uploads/account-user/a1b2c3d4-e5f6-4789-8abc-def012345678-interview.mp4",
"fileName": "interview.mp4",
"fileSize": 1048576,
"durationSeconds": 60,
"mimeType": "video/mp4",
"uploadType": "video",
"readUrl": "https://media.example.com/uploads/account-user/a1b2c3d4-e5f6-4789-8abc-def012345678-interview.mp4"
},
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab"
}
{
"data": {
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab",
"operation": "subtitles_upload_import",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "running",
"pollAfterSeconds": 5
},
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab"
}
{
"data": {
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab",
"operation": "subtitles_upload_import",
"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.fileKey | Referência concluída pertencente ao usuário para a ação de geração. |
data.fileName | Nome sanitizado do arquivo importado. |
data.fileSize | Bytes baixados da origem. |
data.durationSeconds | Duração da fonte detectada em segundos. |
data.mimeType | Tipo MIME da mídia inferido a partir da extensão de arquivo compatível. |
data.uploadType | audio ou video. |
data.readUrl | URL temporária para ler a fonte importada; a geração usa fileKey. |
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.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_import"}'
HTTP 200
{
"data": {
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab",
"operation": "subtitles_upload_import",
"status": "completed",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"resultStored": true,
"result": {
"fileKey": "uploads/account-user/a1b2c3d4-e5f6-4789-8abc-def012345678-interview.mp4",
"fileName": "interview.mp4",
"fileSize": 1048576,
"durationSeconds": 60,
"mimeType": "video/mp4",
"uploadType": "video",
"readUrl": "https://media.example.com/uploads/account-user/a1b2c3d4-e5f6-4789-8abc-def012345678-interview.mp4"
}
}
}
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.
- Esta ação é executada de forma assíncrona. Consulte action_request_get periodicamente com o nome da operação e o requestId original até a conclusão, antes de obter fileKey do resultado.
- Use uma URL HTTPS pública direta de arquivo de áudio/vídeo. Redirecionamentos, credenciais, fragmentos, portas diferentes de 443 e endereços DNS não públicos são rejeitados. Uma página de exibição do YouTube não é uma URL direta de mídia; use as ações dedicadas do YouTube.
- filename é opcional quando o caminho da URL termina com um nome de arquivo de mídia compatível. O nome do arquivo salvo é sanitizado. O servidor detecta a duração real antes de retornar um fileKey.
- A importação prepara a mídia e consome uma chamada mensal de integração bem-sucedida; o limite diário de geração da ferramenta é consumido apenas pela geração subsequente.
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 | CREDENTIAL_IN_QUERY | Foram fornecidas credenciais em um parâmetro de consulta access_token ou api_key. Envie as credenciais nos cabeçalhos. |
| 400 | EMPTY_MEDIA | A URL direta de mídia retornou um corpo vazio. |
| 400 | FILE_TOO_LARGE | A origem declarada ou baixada excede o limite de upload do tipo escolhido. |
| 400 | IDEMPOTENCY_CONFLICT | Os IDs de requisição do cabeçalho e do corpo são diferentes. |
| 400 | INVALID_FILE_TYPE | O nome de arquivo fornecido ou derivado da URL não tem uma extensão compatível com o tipo escolhido. |
| 400 | INVALID_MEDIA_DURATION | Não é possível determinar a duração da mídia baixada, ou ela excede o limite do plano para o tipo escolhido. |
| 400 | INVALID_MEDIA_TYPE | O tipo de conteúdo da resposta não é audio, video, application/ogg nem application/octet-stream. |
| 400 | INVALID_MEDIA_URL | Use uma URL HTTPS direta sem credenciais de usuário, fragmentos ou porta diferente de 443; forneça um nome de arquivo de mídia válido. |
| 400 | INVALID_REQUEST_ID | requestId ou Idempotency-Key não é um UUID v4. |
| 400 | MEDIA_DOWNLOAD_REFUSED | O download direto não retornou HTTP 200. Redirecionamentos são recusados. |
| 400 | MEDIA_IMPORT_FAILED | Não foi possível baixar, analisar ou salvar a fonte; verifique sua URL pública e seu formato de mídia. |
| 400 | MEDIA_URL_NOT_PUBLIC | Não é possível resolver o nome do host, ou pelo menos um endereço resolvido é privado ou não público por outro motivo. |
| 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 | SERVER_RESTARTING | O servidor está reiniciando. Tente novamente em breve e mantenha o mesmo identificador de requisição para uma alteração. |
{
"code": "INSUFFICIENT_SCOPE",
"message": "This credential does not permit the requested action.",
"status": 403,
"details": {
"requiredScopes": ["subtitles:write"]
}
}
Esta página foi útil?

