curl --request POST 'https://api.voicecheap.ai/v1/actions/subtitles_history_update' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"historyId":"history_20261016_001","currentSrtContent":"1\n00:00:00,000 --> 00:00:01,500\nHello world.\n","expectedRevision":1,"layoutOptions":{"maxLinesPerCaption":2,"maxCharactersPerLine":42},"styleOptions":{"fontFamily":"sans","fontSize":"medium","textColor":"white","backgroundStyle":"outline","position":"bottom"},"requestId":"13579bdf-2468-4ace-8bdf-0123456789ab"}'
const input = {
historyId: 'history_20261016_001',
currentSrtContent: '1\n00:00:00,000 --> 00:00:01,500\nHello world.\n',
expectedRevision: 1,
layoutOptions: {
maxLinesPerCaption: 2,
maxCharactersPerLine: 42,
},
styleOptions: {
fontFamily: 'sans',
fontSize: 'medium',
textColor: 'white',
backgroundStyle: 'outline',
position: 'bottom',
},
requestId: '13579bdf-2468-4ace-8bdf-0123456789ab',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/subtitles_history_update', {
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_history_update",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"historyId": "history_20261016_001", "currentSrtContent": "1\n00:00:00,000 --> 00:00:01,500\nHello world.\n", "expectedRevision": 1, "layoutOptions": {"maxLinesPerCaption": 2, "maxCharactersPerLine": 42}, "styleOptions": {"fontFamily": "sans", "fontSize": "medium", "textColor": "white", "backgroundStyle": "outline", "position": "bottom"}, "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": {
"historyId": "history_20261016_001",
"revision": 2,
"updatedAt": 1792152010000,
"currentSrtContent": "1\n00:00:00,000 --> 00:00:01,500\nHello world.\n"
},
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab"
}
{
"data": {
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab",
"operation": "subtitles_history_update",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "running",
"pollAfterSeconds": 5
},
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab"
}
{
"data": {
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab",
"operation": "subtitles_history_update",
"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
Editar legendas salvas
Atualize o SRT e o layout salvos usando sua revisão mais recente. Uma revisão desatualizada é rejeitada para impedir que edições simultâneas sobrescrevam umas às outras.
POST
/
v1
/
actions
/
subtitles_history_update
curl --request POST 'https://api.voicecheap.ai/v1/actions/subtitles_history_update' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"historyId":"history_20261016_001","currentSrtContent":"1\n00:00:00,000 --> 00:00:01,500\nHello world.\n","expectedRevision":1,"layoutOptions":{"maxLinesPerCaption":2,"maxCharactersPerLine":42},"styleOptions":{"fontFamily":"sans","fontSize":"medium","textColor":"white","backgroundStyle":"outline","position":"bottom"},"requestId":"13579bdf-2468-4ace-8bdf-0123456789ab"}'
const input = {
historyId: 'history_20261016_001',
currentSrtContent: '1\n00:00:00,000 --> 00:00:01,500\nHello world.\n',
expectedRevision: 1,
layoutOptions: {
maxLinesPerCaption: 2,
maxCharactersPerLine: 42,
},
styleOptions: {
fontFamily: 'sans',
fontSize: 'medium',
textColor: 'white',
backgroundStyle: 'outline',
position: 'bottom',
},
requestId: '13579bdf-2468-4ace-8bdf-0123456789ab',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/subtitles_history_update', {
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_history_update",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"historyId": "history_20261016_001", "currentSrtContent": "1\n00:00:00,000 --> 00:00:01,500\nHello world.\n", "expectedRevision": 1, "layoutOptions": {"maxLinesPerCaption": 2, "maxCharactersPerLine": 42}, "styleOptions": {"fontFamily": "sans", "fontSize": "medium", "textColor": "white", "backgroundStyle": "outline", "position": "bottom"}, "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": {
"historyId": "history_20261016_001",
"revision": 2,
"updatedAt": 1792152010000,
"currentSrtContent": "1\n00:00:00,000 --> 00:00:01,500\nHello world.\n"
},
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab"
}
{
"data": {
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab",
"operation": "subtitles_history_update",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "running",
"pollAfterSeconds": 5
},
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab"
}
{
"data": {
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab",
"operation": "subtitles_history_update",
"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"
}
Atualize o SRT e o layout salvos usando sua revisão mais recente. Uma revisão desatualizada é rejeitada para impedir que edições simultâneas sobrescrevam umas às outras.
Permissões necessárias:
POST https://api.voicecheap.ai/v1/actions/subtitles_history_update
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ínimo: 1. Comprimento máximo: 160. Padrão:
^[A-Za-z0-9_-]+$.string
obrigatório
Valor de texto.Comprimento mínimo: 1. Comprimento máximo: 2097152.
integer
obrigatório
Valor inteiro.Máximo: 9007199254740991.
object
Objeto JSON. Consulte o esquema de entrada completo para ver os campos aninhados.
object
Objeto JSON. Consulte o esquema de entrada completo para ver os campos aninhados.
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": {
"historyId": {
"type": "string",
"minLength": 1,
"maxLength": 160,
"pattern": "^[A-Za-z0-9_-]+$"
},
"currentSrtContent": {
"type": "string",
"minLength": 1,
"maxLength": 2097152
},
"expectedRevision": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"layoutOptions": {
"type": "object",
"properties": {
"maxLinesPerCaption": {
"anyOf": [
{
"type": "number",
"const": 1
},
{
"type": "number",
"const": 2
},
{
"type": "number",
"const": 3
}
]
},
"maxCharactersPerLine": {
"type": "integer",
"minimum": 24,
"maximum": 64
}
},
"required": ["maxLinesPerCaption", "maxCharactersPerLine"],
"additionalProperties": false
},
"styleOptions": {
"type": "object",
"properties": {
"fontFamily": {
"type": "string",
"enum": ["sans", "serif", "mono"]
},
"fontSize": {
"type": "string",
"enum": ["small", "medium", "large"]
},
"textColor": {
"type": "string",
"enum": ["white", "yellow", "cyan"]
},
"backgroundStyle": {
"type": "string",
"enum": ["outline", "box", "shadow"]
},
"position": {
"type": "string",
"enum": ["bottom", "middle"]
}
},
"required": ["fontFamily", "fontSize", "textColor", "backgroundStyle", "position"],
"additionalProperties": false
},
"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": ["historyId", "currentSrtContent", "expectedRevision"],
"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_history_update' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"historyId":"history_20261016_001","currentSrtContent":"1\n00:00:00,000 --> 00:00:01,500\nHello world.\n","expectedRevision":1,"layoutOptions":{"maxLinesPerCaption":2,"maxCharactersPerLine":42},"styleOptions":{"fontFamily":"sans","fontSize":"medium","textColor":"white","backgroundStyle":"outline","position":"bottom"},"requestId":"13579bdf-2468-4ace-8bdf-0123456789ab"}'
const input = {
historyId: 'history_20261016_001',
currentSrtContent: '1\n00:00:00,000 --> 00:00:01,500\nHello world.\n',
expectedRevision: 1,
layoutOptions: {
maxLinesPerCaption: 2,
maxCharactersPerLine: 42,
},
styleOptions: {
fontFamily: 'sans',
fontSize: 'medium',
textColor: 'white',
backgroundStyle: 'outline',
position: 'bottom',
},
requestId: '13579bdf-2468-4ace-8bdf-0123456789ab',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/subtitles_history_update', {
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_history_update",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"historyId": "history_20261016_001", "currentSrtContent": "1\n00:00:00,000 --> 00:00:01,500\nHello world.\n", "expectedRevision": 1, "layoutOptions": {"maxLinesPerCaption": 2, "maxCharactersPerLine": 42}, "styleOptions": {"fontFamily": "sans", "fontSize": "medium", "textColor": "white", "backgroundStyle": "outline", "position": "bottom"}, "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. O mesmo ID de histórico editável de legendas, com sua revisão incrementada, timestamp de atualização e SRT atual normalizado.{
"data": {
"historyId": "history_20261016_001",
"revision": 2,
"updatedAt": 1792152010000,
"currentSrtContent": "1\n00:00:00,000 --> 00:00:01,500\nHello world.\n"
},
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab"
}
{
"data": {
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab",
"operation": "subtitles_history_update",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "running",
"pollAfterSeconds": 5
},
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab"
}
{
"data": {
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab",
"operation": "subtitles_history_update",
"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.historyId | Item de legendas salvo existente. |
data.revision | Revisão anterior mais um. |
data.updatedAt | Timestamp Unix de atualização em milissegundos. |
data.currentSrtContent | Texto SRT salvo, validado, ordenado e normalizado. |
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_history_update"}'
HTTP 200
{
"data": {
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab",
"operation": "subtitles_history_update",
"status": "completed",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"resultStored": true,
"result": {
"historyId": "history_20261016_001",
"revision": 2,
"updatedAt": 1792152010000,
"currentSrtContent": "1\n00:00:00,000 --> 00:00:01,500\nHello world.\n"
}
}
}
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.
- Leia subtitles_history_get primeiro e depois passe sua revision como expectedRevision. Uma revisão desatualizada retorna VIDEO_TO_SRT_HISTORY_CONFLICT e não pode sobrescrever outra edição.
- Os blocos SRT são interpretados, ordenados e normalizados; eles não podem se sobrepor nem exceder a duração da mídia de origem mais 0.5 segundos. A entrada é limitada a 2 MiB de SRT em UTF-8.
- layoutOptions e styleOptions omitidos são normalizados para os padrões usuais (2 linhas, 42 caracteres, sans/medium/white/outline/bottom), em vez de preservar implicitamente os valores personalizados anteriores. Inclua ambos para manter a formatação personalizada.
- Edita texto e formatação no histórico SRT salvo. Não renderiza um novo vídeo, não transcreve novamente, não consome um envio de mídia nem usa outra unidade do limite diário 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 | CREDENTIAL_IN_QUERY | Foram fornecidas credenciais em um parâmetro de consulta access_token ou api_key. Envie as credenciais nos cabeçalhos. |
| 400 | IDEMPOTENCY_CONFLICT | Os IDs de requisição do cabeçalho e do corpo são diferentes. |
| 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. |
| 400 | VIDEO_TO_SRT_HISTORY_INVALID_SRT | O texto dos blocos de legenda ou a estrutura de timestamps do SRT é inválido. |
| 400 | VIDEO_TO_SRT_HISTORY_OUTSIDE_MEDIA | Um bloco termina além da duração registrada da origem somada à tolerância de 0.5 segundo. |
| 400 | VIDEO_TO_SRT_HISTORY_OVERLAP | Pelo menos dois blocos de legenda se sobrepõem. |
| 400 | VIDEO_TO_SRT_HISTORY_SRT_TOO_LARGE | O SRT editado excede o limite de 2 MiB em UTF-8. |
| 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. |
| 404 | VIDEO_TO_SRT_HISTORY_NOT_FOUND | O item do histórico editável de legendas pertencente ao usuário executor não existe. |
| 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. |
| 409 | VIDEO_TO_SRT_HISTORY_CONFLICT | expectedRevision está desatualizada. Leia subtitles_history_get novamente e use a revisão atual antes de tentar a edição outra vez. |
| 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?

