> ## 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.

# Traduzir legendas

> Traduza legendas SRT ou VTT, preservando os tempos e a formatação. Salva o resultado no histórico de traduções de legendas. Retorna uma referência compacta ao resultado salvo; use getAction ou downloadAction dessa referência para recuperar a saída completa.

Traduza legendas SRT ou VTT, preservando os tempos e a formatação. Salva o resultado no histórico de traduções de legendas. Retorna uma referência compacta ao resultado salvo; use getAction ou downloadAction dessa referência para recuperar a saída completa.

```http theme={null}
POST https://api.voicecheap.ai/v1/actions/subtitles_translate
```

## Autenticação e permissões

<ParamField header="x-api-key" type="string" required>
  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.
</ParamField>

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

<ParamField body="subtitleContent" type="string" required>
  Valor de texto.

  Comprimento mínimo: 1. Comprimento máximo: 2097152.
</ParamField>

<ParamField body="fileName" type="string">
  Valor de texto.

  Comprimento mínimo: 1. Comprimento máximo: 255. Padrão: `^[^/\\\r\n\0]+$`.
</ParamField>

<ParamField body="format" type="string">
  Valor de texto.

  Valores aceitos: "srt", "vtt".
</ParamField>

<ParamField body="sourceLanguage" type="string">
  Valor de texto.

  Comprimento mínimo: 2. Comprimento máximo: 60.
</ParamField>

<ParamField body="targetLanguage" type="string" required>
  Valor de texto.

  Comprimento mínimo: 2. Comprimento máximo: 60.
</ParamField>

<ParamField body="requestId" type="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}$`.
</ParamField>

<Accordion title="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.

  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "subtitleContent": {
        "type": "string",
        "minLength": 1,
        "maxLength": 2097152
      },
      "fileName": {
        "type": "string",
        "minLength": 1,
        "maxLength": 255,
        "pattern": "^[^/\\\\\\r\\n\\0]+$"
      },
      "format": {
        "type": "string",
        "enum": ["srt", "vtt"]
      },
      "sourceLanguage": {
        "type": "string",
        "minLength": 2,
        "maxLength": 60
      },
      "targetLanguage": {
        "type": "string",
        "minLength": 2,
        "maxLength": 60
      },
      "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": ["subtitleContent", "targetLanguage"],
    "additionalProperties": false
  }
  ```
</Accordion>

## 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.

<RequestExample>
  ```bash cURL theme={null}
  curl --request POST 'https://api.voicecheap.ai/v1/actions/subtitles_translate' \
    --header "x-api-key: $VOICECHEAP_API_KEY" \
    --header 'Content-Type: application/json' \
    --data '{"subtitleContent":"1\n00:00:00,000 --> 00:00:01,500\nHello world.\n","fileName":"interview.srt","format":"srt","sourceLanguage":"english","targetLanguage":"french","requestId":"13579bdf-2468-4ace-8bdf-0123456789ab"}'
  ```

  ```javascript JavaScript theme={null}
  const input = {
    subtitleContent: '1\n00:00:00,000 --> 00:00:01,500\nHello world.\n',
    fileName: 'interview.srt',
    format: 'srt',
    sourceLanguage: 'english',
    targetLanguage: 'french',
    requestId: '13579bdf-2468-4ace-8bdf-0123456789ab',
  };
  const response = await fetch('https://api.voicecheap.ai/v1/actions/subtitles_translate', {
    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_translate",
      headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
      json={"subtitleContent": "1\n00:00:00,000 --> 00:00:01,500\nHello world.\n", "fileName": "interview.srt", "format": "srt", "sourceLanguage": "english", "targetLanguage": "french", "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)
  ```
</RequestExample>

## 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 salva de tradução de legendas. Seu JSON completo contém originalContent, translatedContent, sourceFormat/outputFormat correspondentes, fileName, sourceLanguage, targetLanguage, cueCount e characterCount; historyId e detectedLanguage são opcionais.

<ResponseExample>
  ```json HTTP 202 theme={null}
  {
    "data": {
      "requestId": "13579bdf-2468-4ace-8bdf-0123456789ab",
      "status": "running",
      "pollAction": "action_request_get",
      "pollAfterSeconds": 5
    },
    "requestId": "13579bdf-2468-4ace-8bdf-0123456789ab"
  }
  ```

  ```json HTTP 200 theme={null}
  {
    "data": {
      "resultId": "b3caf96f-5f2a-4619-832c-a12c0d57f78b",
      "operation": "subtitles_translate",
      "createdAt": 1792152000000,
      "fileName": "voicecheap-subtitles_translate-b3caf96f-5f2a-4619-832c-a12c0d57f78b.json",
      "byteLength": 365,
      "contentType": "application/json; charset=utf-8",
      "status": "completed",
      "requestId": "13579bdf-2468-4ace-8bdf-0123456789ab",
      "getAction": "subtitles_result_get",
      "downloadAction": "subtitles_result_download",
      "listAction": "subtitles_result_list"
    },
    "requestId": "13579bdf-2468-4ace-8bdf-0123456789ab"
  }
  ```

  ```json HTTP 202 replay_running theme={null}
  {
    "data": {
      "requestId": "13579bdf-2468-4ace-8bdf-0123456789ab",
      "operation": "subtitles_translate",
      "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_translate",
      "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"
  }
  ```
</ResponseExample>

## Campos do resultado

| Campo | Descrição |
| - | - |
| `data.resultId` | UUID da saída salva pertencente à conta. Use-o com getAction ou downloadAction; ele é diferente de requestId e de qualquer historyId. |
| `data.operation` | Ação de geração que produziu este JSON salvo. |
| `data.createdAt` | Carimbo de data/hora Unix em milissegundos de quando a saída salva foi preparada. |
| `data.fileName` | Nome de arquivo sugerido para uma exportação JSON. |
| `data.byteLength` | Bytes UTF-8 da saída serializada completa, não dos metadados compactos. |
| `data.contentType` | application/json; charset=utf-8. |
| `data.status` | completed após uma geração bem-sucedida. O histórico de resultados também pode exibir entradas pending de recuperação. |
| `data.requestId` | UUID da requisição de ação original, quando registrado. |
| `data.getAction` | Ação de recuperação de conteúdo pertencente ao usuário; includeContent tem false como padrão e deve ser true para obter a saída estruturada completa. |
| `data.downloadAction` | Ação de exportação autenticada que retorna o JSON completo como uma string de conteúdo. |
| `data.listAction` | Ação de listagem de saídas salvas que lhe pertencem neste domínio de permissões. |

## 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_translate"}'
```

```json HTTP 200 theme={null}
{
  "data": {
    "requestId": "13579bdf-2468-4ace-8bdf-0123456789ab",
    "operation": "subtitles_translate",
    "status": "completed",
    "createdAt": 1792144800000,
    "updatedAt": 1792144820000,
    "resultStored": true,
    "result": {
      "resultId": "b3caf96f-5f2a-4619-832c-a12c0d57f78b",
      "operation": "subtitles_translate",
      "createdAt": 1792152000000,
      "fileName": "voicecheap-subtitles_translate-b3caf96f-5f2a-4619-832c-a12c0d57f78b.json",
      "byteLength": 365,
      "contentType": "application/json; charset=utf-8",
      "status": "completed",
      "requestId": "13579bdf-2468-4ace-8bdf-0123456789ab",
      "getAction": "subtitles_result_get",
      "downloadAction": "subtitles_result_download",
      "listAction": "subtitles_result_list"
    }
  }
}
```

## 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.
* Esta é uma ação assíncrona. O resultado inicial do transporte é uma requisição running com pollAction; consulte action\_request\_get periodicamente com esta operação e o requestId original. O resultado da operação concluída mostrado aqui é uma referência compacta à saída salva, não o corpo gerado.
* A saída completa é salva sob a propriedade autenticada em armazenamento criptografado, independentemente do cache limitado de consulta de ações. Chame o getAction retornado com resultId e includeContent: true para obter JSON estruturado, ou downloadAction com resultId para obter texto JSON. listAction oferece uma forma de recuperação quando apenas a requisição original é conhecida.
* O JSON salvo é limitado a 32 MiB. Os metadados nunca expõem sua chave de criptografia do armazenamento nem uma URL não autenticada de download da transcrição.
* Uma geração bem-sucedida confirma o uso de uma unidade da cota pessoal da ferramenta. Uma geração com falha normalmente libera a reserva da ferramenta. Quando a persistência da saída é incerta, inspecione a mesma requisição e o histórico de resultados salvos antes de gerar novamente; o servidor mantém a reserva para impedir uso duplicado.
* Os planos superiores sem teto mensal de integração ainda têm as cotas diárias específicas de cada ferramenta e os limites de mídia abaixo. Essas ações independentes usam a cota da ferramenta em vez de minutos de dublagem ou caracteres TTS.
* Forneça texto SRT ou VTT em UTF-8 com até 2 MiB. format pode ser srt ou vtt; quando omitido, format é inferido a partir do conteúdo ou do nome do arquivo. targetLanguage é obrigatório; sourceLanguage usa detecção automática por padrão.
* A saída preserva a temporização dos blocos de origem e o formato SRT/VTT selecionado. characterCount conta os caracteres do texto dos blocos de origem, não os bytes de saída. O fileName normalizado descreve o arquivo de legendas, não o JSON externo salvo.
* Cota diária por ferramenta: Beginner 5, Starter 15, Creator 30, Pro 60, Scale 100 e Enterprise 100 gerações bem-sucedidas. Ela é compartilhada com a ferramenta web correspondente e usa a janela de renovação da ferramenta da conta.
* O salvamento do histórico de tradução de legendas ocorre sem garantia; use o resultado de integração salvo para recuperar o conteúdo completo. Esta ação não consome uma origem de mídia enviada.

## 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 | `SUBTITLE_CONTENT_REQUIRED` | O conteúdo das legendas não contém texto. |
| 400 | `SUBTITLE_EMPTY` | Nenhum bloco com texto de legenda foi encontrado. |
| 400 | `SUBTITLE_FILE_TOO_LARGE` | A entrada de legendas em UTF-8 excede 2 MiB. |
| 400 | `SUBTITLE_INVALID_SRT` | A estrutura dos blocos SRT é inválida. |
| 400 | `SUBTITLE_INVALID_SRT_TIMESTAMP` | Não é possível interpretar um timestamp SRT. |
| 400 | `SUBTITLE_INVALID_SRT_TIMING` | A marcação de tempo dos blocos SRT é inválida. |
| 400 | `SUBTITLE_INVALID_VTT` | O conteúdo VTT não tem um cabeçalho WEBVTT válido. |
| 400 | `SUBTITLE_INVALID_VTT_TIMESTAMP` | Não é possível interpretar um timestamp VTT. |
| 400 | `SUBTITLE_INVALID_VTT_TIMING` | Uma linha de marcação de tempo VTT é inválida. |
| 400 | `SUBTITLE_TRANSLATOR_SAME_LANGUAGE` | Os idiomas de origem e de destino normalizados são idênticos. |
| 400 | `SUBTITLE_TRANSLATOR_TARGET_LANGUAGE_REQUIRED` | Nenhum idioma de destino utilizável foi fornecido. |
| 400 | `SUBTITLE_UNSUPPORTED_VTT_BLOCK` | O arquivo VTT contém um bloco que o tradutor não consegue preservar. |
| 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. |
| 410 | `TOOL_RESULT_ACCOUNT_UNAVAILABLE` | A conta do ator está sendo excluída ou não existe mais, portanto não é possível salvar um resultado durável. |
| 413 | `TOOL_RESULT_TOO_LARGE` | O JSON gerado completo excede 32 MiB e não pode ser salvo como resultado de integração. |
| 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. |
| 429 | `SUBTITLE_TRANSLATOR_TOOL_DAILY_LIMIT_REACHED` | O ator esgotou a cota diária do tradutor de legendas. |
| 500 | `INTERNAL_ERROR` | Verifique o estado da requisição salva e o histórico do recurso antes de decidir repetir uma alteração. |
| 502 | `INTERNAL_ERROR` | A geração ou o salvamento da saída falhou. Verifique a requisição original e o histórico de resultados salvos antes de iniciar outra geraçã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` | O resultado da geração ou da persistência do resultado salvo é incerto ou está temporariamente indisponível; use a recuperação autenticada de resultados antes de gerar novamente. |
| 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.