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

# Download a subtitled video

> Get a temporary download URL for one of your saved videos with subtitles.

Get a temporary download URL for one of your saved videos with subtitles.

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

## Authentication and permissions

**x-api-key** `string` *required*

Send a VoiceCheap API key in this header. Authorization: Bearer with the same API key is also supported. OAuth access tokens are accepted only by
MCP, not by this REST endpoint.

Required permissions: `subtitles:read`.

An active paid subscription is required. Permissions do not change team roles, resource ownership, media credits, or plan limits.

## Parameters

**historyId** `string` *required*

Text value.

Minimum length: 1. Maximum length: 160. Pattern: `^[A-Za-z0-9_-]+$`.

> [accordion] Complete input schema
>
> The JSON Schema below preserves the exact field names, nested types, defaults, bounds, and accepted values exposed by discovery. Additional cross-field rules are listed in the operation notes.
>
> ```json theme={null}
> {
>   "type": "object",
>   "properties": {
>     "historyId": {
>       "type": "string",
>       "minLength": 1,
>       "maxLength": 160,
>       "pattern": "^[A-Za-z0-9_-]+$"
>     }
>   },
>   "required": ["historyId"],
>   "additionalProperties": false
> }
> ```

## Request examples

Replace example resource identifiers and media keys with values returned for your account. Keep the request identifier stable when retrying the same mutation.

```bash cURL theme={null}
curl --request POST 'https://api.voicecheap.ai/v1/actions/subtitles_burn_download' \
  --header "x-api-key: $VOICECHEAP_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{"historyId":"history_20261016_001"}'
```

```javascript JavaScript theme={null}
const input = {
  historyId: 'history_20261016_001',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/subtitles_burn_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_burn_download",
    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)
```

## Response

A successful first execution returns HTTP 200 with the operation result under data. A replay may return saved request state instead. The example shows one supported response, not every optional field.

A refreshed temporary download URL for an already rendered actor-owned subtitle video.

```json HTTP 200 theme={null}
{
  "data": {
    "historyId": "history_20261016_001",
    "fileName": "interview.mp4",
    "downloadUrl": "https://media.example.com/outputs/subtitled-interview.mp4"
  }
}
```

## Result fields

| Field | Description |
| - | - |
| `data.historyId` | Selected owned subtitle-burn history ID. |
| `data.fileName` | Original source filename stored in history. |
| `data.downloadUrl` | Temporary media URL for the rendered video; treat it as private access data. |

## Operation notes

* Requires a paid subscription and the action permission. The actor's personal tool plan is rechecked at execution; saved tools and upload references belong to that actor, including when the credential is associated with a team.
* A successful action uses one shared monthly API/MCP call. Beginner allows 500, Starter 5,000 and Creator 25,000 calls/month; Pro, Scale and Enterprise have no monthly ceiling. Per-minute limits still apply: 30, 60, 120, 180, 300 and 600 respectively. Tool generation allowances are separate.
* historyId selects saved add-subtitles history from either an uploaded or YouTube source. The handler resolves ownership before issuing the video URL.
* The returned fileName is the original source history filename and need not describe the actual rendered MP4 extension. downloadUrl points to the rendered video.
* This retrieves an existing output and does not render again, consume an upload or use the daily render allowance.

## Usage

Each successful invocation consumes one monthly API/MCP call. Media credits and the operation's own generation allowances also apply.

## Errors

| HTTP status | Code | Meaning or recovery |
| - | - | - |
| 400 | `CREDENTIAL_IN_QUERY` | Credentials were supplied in an access\_token or api\_key query parameter. Send credentials in headers. |
| 400 | `VALIDATION_ERROR` | Arguments do not satisfy the action schema, or an unknown argument was supplied. |
| 401 | `API_KEY_EXPIRED` | The API key has expired. |
| 401 | `INVALID_API_KEY` | Provide a valid, unexpired API key. |
| 401 | `INVALID_CREDENTIAL` | The Authorization header is malformed or conflicts with x-api-key. |
| 401 | `MISSING_CREDENTIAL` | No usable header credential was supplied, or it exceeded 4096 characters. |
| 401 | `USER_NOT_FOUND` | The credential's account no longer exists. |
| 403 | `AMBIGUOUS_TEAM_API_KEY` | The credential's user belongs to more than one team, so the billing context is ambiguous. |
| 403 | `INSUFFICIENT_SCOPE` | The API key or MCP connection lacks the required action permission. |
| 403 | `INTEGRATION_PLAN_UNSUPPORTED` | The account's integration limits could not be verified. |
| 403 | `PAID_SUBSCRIPTION_REQUIRED` | The authenticated actor no longer has a paid subscription when this tool action executes. |
| 403 | `SUBSCRIPTION_REQUIRED` | Use an active paid subscription. |
| 403 | `TEAM_OWNER_NOT_FOUND` | The effective team owner account could not be found. |
| 404 | `ADD_SUBTITLES_HISTORY_NOT_FOUND` | The rendered subtitle history item does not exist for this actor. |
| 429 | `INTEGRATION_MONTHLY_LIMIT_REACHED` | Used and pending calls have reached the shared monthly API/MCP allowance. |
| 429 | `INTEGRATION_RATE_LIMIT_REACHED` | The account has reached its per-minute integration limit; inspect retryAfterSeconds. |
| 500 | `INTERNAL_ERROR` | The saved output video URL could not be read. |
| 503 | `SERVER_RESTARTING` | The server is restarting. Retry shortly and keep the same request identifier for a mutation. |

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