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

# Exportar o resultado salvo de uma ação de legendas

> Exporte o resultado completo que lhe pertence como texto JSON com nome de arquivo e tipo de conteúdo. O acesso continua autenticado; nenhuma URL pública de mídia expõe a transcrição.

Exporte o resultado completo que lhe pertence como texto JSON com nome de arquivo e tipo de conteúdo. O acesso continua autenticado; nenhuma URL pública de mídia expõe a transcrição.

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

## Autenticação e permissões

**x-api-key** `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.

Permissões necessárias: `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

**resultId** `string` *required*

Valor de texto.

Formato: "uuid". Padrão: `^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$`.

> [accordion] 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": {
>     "resultId": {
>       "type": "string",
>       "format": "uuid",
>       "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
>     }
>   },
>   "required": ["resultId"],
>   "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.

```bash cURL theme={null}
curl --request POST 'https://api.voicecheap.ai/v1/actions/subtitles_result_download' \
  --header "x-api-key: $VOICECHEAP_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{"resultId":"b3caf96f-5f2a-4619-832c-a12c0d57f78b"}'
```

```javascript JavaScript theme={null}
const input = {
  resultId: 'b3caf96f-5f2a-4619-832c-a12c0d57f78b',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/subtitles_result_download', {
  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_result_download",
    headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
    json={"resultId": "b3caf96f-5f2a-4619-832c-a12c0d57f78b"},
    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.

Metadados de saída salvos com o JSON gerado completo serializado como uma string de conteúdo para uma exportação local autenticada.

```json HTTP 200 theme={null}
{
  "data": {
    "resultId": "b3caf96f-5f2a-4619-832c-a12c0d57f78b",
    "operation": "captions_transcribe",
    "createdAt": 1792152000000,
    "fileName": "voicecheap-captions_transcribe-b3caf96f-5f2a-4619-832c-a12c0d57f78b.json",
    "byteLength": 190,
    "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",
    "content": "{\"words\":[{\"text\":\"Hello\",\"startMs\":0,\"endMs\":500,\"speakerId\":\"speaker_0\"},{\"text\":\"world.\",\"startMs\":500,\"endMs\":1500,\"speakerId\":\"speaker_0\"}],\"detectedLanguage\":\"en\",\"durationSeconds\":60}"
  }
}
```

## 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. |
| `data.content` | Resultado público original completo da geração codificado como texto JSON, pronto para salvar em fileName. |

## 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.
* resultId é um UUID de uma referência de geração concluída ou do result\_list deste domínio. Ele é diferente do requestId da ação e do historyId da ferramenta da web.
* Os resultados pertencem ao ator autenticado e ao domínio de permissão. Um resultado de subtitles não pode ser lido por ações de transcription, ou vice-versa.
* O JSON completo salvo é criptografado em repouso e mantido independentemente do cache limitado de consultas periódicas da ação. A recuperação continua autenticada; nenhuma URL pública de JSON de transcrição ou legendas é emitida.
* Estas ações recuperam saídas existentes e não geram mídia nem usam uma cota diária. Cada recuperação bem-sucedida ainda usa uma chamada mensal de integração.
* Metadados pending significam que a persistência da saída precisa de recuperação. Ler o conteúdo ou baixá-lo tenta recuperar um objeto criptografado já salvo; verifique-o antes de iniciar outra geração.
* Grave content em fileName usando UTF-8 ou use JSON.parse(content) para recuperar a saída estruturada. A resposta externa não contém uma propriedade result nem uma URL de download de mídia.
* byteLength descreve o JSON UTF-8 dentro de content; contentType é application/json; charset=utf-8. O download também tenta recuperar a saída criptografada pendente.

## 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 | `TOOL_RESULT_NOT_FOUND` | O resultado está ausente, pertence a outro autor da ação ou pertence ao outro domínio de permissões. |
| 410 | `TOOL_RESULT_ACCOUNT_UNAVAILABLE` | A conta do usuário executor está sendo excluída ou deixou de existir durante a recuperaçã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. |
| 500 | `INTERNAL_ERROR` | Não foi possível ler ou validar o JSON concluído salvo. |
| 503 | `INTERNAL_ERROR` | Um resultado salvo com status pending ainda não pode ser recuperado; inspecione o mesmo resultado 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:read"]
  }
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.