curl --request POST 'https://api.voicecheap.ai/v1/actions/subtitles_burn_history_get' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"historyId":"history_20261016_001"}'
const input = {
historyId: 'history_20261016_001',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/subtitles_burn_history_get', {
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_burn_history_get",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"historyId": "history_20261016_001"},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
{
"data": {
"historyId": "history_20261016_001",
"fileName": "interview.mp4",
"createdAt": 1792152000000,
"updatedAt": 1792152000000,
"fileSizeBytes": 1048576,
"fileSizeMb": 1,
"durationSeconds": 60,
"durationMinutes": 1,
"mimeType": "video/mp4",
"extension": "mp4",
"detectedLanguage": "en",
"status": "success",
"sourceType": "upload",
"sourceSrtContent": "1\n00:00:00,000 --> 00:00:01,500\nHello world.\n",
"subtitleLayout": {
"maxLinesPerCaption": 2,
"maxCharactersPerLine": 42
},
"subtitleStyle": {
"fontFamily": "sans",
"fontSize": "medium",
"textColor": "white",
"backgroundStyle": "outline",
"position": "bottom"
},
"subtitledVideoUrl": "https://media.example.com/outputs/subtitled-interview.mp4"
}
}
Legendas
Consultar resultado de vídeo legendado
Leia um dos seus resultados salvos de vídeo legendado, incluindo seu texto de saída ou URL de mídia.
POST
/
v1
/
actions
/
subtitles_burn_history_get
curl --request POST 'https://api.voicecheap.ai/v1/actions/subtitles_burn_history_get' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"historyId":"history_20261016_001"}'
const input = {
historyId: 'history_20261016_001',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/subtitles_burn_history_get', {
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_burn_history_get",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"historyId": "history_20261016_001"},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
{
"data": {
"historyId": "history_20261016_001",
"fileName": "interview.mp4",
"createdAt": 1792152000000,
"updatedAt": 1792152000000,
"fileSizeBytes": 1048576,
"fileSizeMb": 1,
"durationSeconds": 60,
"durationMinutes": 1,
"mimeType": "video/mp4",
"extension": "mp4",
"detectedLanguage": "en",
"status": "success",
"sourceType": "upload",
"sourceSrtContent": "1\n00:00:00,000 --> 00:00:01,500\nHello world.\n",
"subtitleLayout": {
"maxLinesPerCaption": 2,
"maxCharactersPerLine": 42
},
"subtitleStyle": {
"fontFamily": "sans",
"fontSize": "medium",
"textColor": "white",
"backgroundStyle": "outline",
"position": "bottom"
},
"subtitledVideoUrl": "https://media.example.com/outputs/subtitled-interview.mp4"
}
}
Leia um dos seus resultados salvos de vídeo legendado, incluindo seu texto de saída ou URL de mídia.
Permissões necessárias:
POST https://api.voicecheap.ai/v1/actions/subtitles_burn_history_get
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:read.
É 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ínimo: 1. Comprimento máximo: 160. Padrão:
^[A-Za-z0-9_-]+$.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": {
"historyId": {
"type": "string",
"minLength": 1,
"maxLength": 160,
"pattern": "^[A-Za-z0-9_-]+$"
}
},
"required": ["historyId"],
"additionalProperties": false
}
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_burn_history_get' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"historyId":"history_20261016_001"}'
const input = {
historyId: 'history_20261016_001',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/subtitles_burn_history_get', {
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_burn_history_get",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"historyId": "history_20261016_001"},
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. O item completo do histórico de vídeos legendados pertencente ao autor da ação, incluindo seu conteúdo de saída.{
"data": {
"historyId": "history_20261016_001",
"fileName": "interview.mp4",
"createdAt": 1792152000000,
"updatedAt": 1792152000000,
"fileSizeBytes": 1048576,
"fileSizeMb": 1,
"durationSeconds": 60,
"durationMinutes": 1,
"mimeType": "video/mp4",
"extension": "mp4",
"detectedLanguage": "en",
"status": "success",
"sourceType": "upload",
"sourceSrtContent": "1\n00:00:00,000 --> 00:00:01,500\nHello world.\n",
"subtitleLayout": {
"maxLinesPerCaption": 2,
"maxCharactersPerLine": 42
},
"subtitleStyle": {
"fontFamily": "sans",
"fontSize": "medium",
"textColor": "white",
"backgroundStyle": "outline",
"position": "bottom"
},
"subtitledVideoUrl": "https://media.example.com/outputs/subtitled-interview.mp4"
}
}
Campos do resultado
| Campo | Descrição |
|---|---|
data.historyId | ID do item de histórico de ferramenta web pertencente à conta. |
data.createdAt | Timestamp Unix em milissegundos. |
data.updatedAt | Timestamp Unix em milissegundos. |
data.sourceType | upload ou youtube. |
data.sourceSrtContent | SRT de origem salvo usado para renderização. |
data.subtitleLayout | Configurações de layout salvas. |
data.subtitleStyle | Configurações de estilo salvas. |
data.subtitledVideoUrl | URL temporária do vídeo de saída já renderizado. |
data.youtubeUrl | URL original do YouTube opcional. |
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.
- historyId deve ser obtido do history_list correspondente pertencente ao ator ou de uma geração bem-sucedida. IDs de outro usuário ou de outra coleção de histórico não concedem acesso.
- Esta leitura retorna o histórico completo salvo da ferramenta, não um resultId durável da integração. Ela não gera novamente, não consome um upload nem usa uma geração diária da ferramenta.
- subtitledVideoUrl é atualizada a partir do armazenamento de mídia pertencente à conta em cada leitura de detalhes. youtubeUrl é incluída em um item do histórico originado do YouTube. sourceSrtContent e as configurações de renderização são retornados para reutilizaçã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 | CREDENTIAL_IN_QUERY | Foram fornecidas credenciais em um parâmetro de consulta access_token ou api_key. Envie as credenciais nos cabeçalhos. |
| 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 | 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. |
| 404 | ADD_SUBTITLES_HISTORY_NOT_FOUND | O histórico solicitado de vídeo legendado não foi encontrado para este ator. |
| 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 | Não foi possível ler o conteúdo do histórico salvo. |
| 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:read"]
}
}
Esta página foi útil?

