> ## 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.
# Dub a supplied translation
> Generate speech for your target-language SRT on an existing transcribed project. Speech and optional lip sync use the normal media credits. Poll projects_status.
Generate speech for your target-language SRT on an existing transcribed project. Speech and optional lip sync use the normal media credits. Poll projects\_status.
```http theme={null}
POST https://api.voicecheap.ai/v1/actions/translations_dub
```
## Authentication and permissions
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: `translations:write`.
An active paid subscription is required. Permissions do not change team roles, resource ownership, media credits, or plan limits.
## Parameters
Text value.
Minimum length: 1. Maximum length: 200. Pattern: `^[^/\\]+$`.
Boolean value.
Boolean value.
Numeric value.
Minimum: 1. Maximum: 70.
Text value.
Allowed values: "cloning", "custom".
Text value.
Minimum length: 1. Maximum length: 128.
Boolean value.
Text value.
Allowed values: "translated", "original".
Text value.
Allowed values: "studio", "realistic".
Text value.
Allowed values: "standard", "pro", "studio".
Boolean value.
JSON object. See the complete input schema for its nested fields.
List of values. See the complete input schema for its item structure.
Maximum items: 100.
Text value.
Allowed values: "afrikaans", "albanian", "amharic", "arabic", "armenian", "assamese", "azerbaijani", "basque", "belarusian", "bengali", "bosnian", "bulgarian", "catalan", "croatian", "czech", "danish", "dutch", "english", "british english", "estonian", "finnish", "french", "french canadian", "galician", "german", "greek", "gujarati", "hebrew", "hindi", "hungarian", "icelandic", "indonesian", "irish", "italian", "japanese", "kannada", "kazakh", "khmer", "korean", "lao", "latvian", "lithuanian", "macedonian", "malay", "malayalam", "mandarin", "marathi", "mongolian", "nepali", "norwegian", "persian", "polish", "portuguese", "brazilian portuguese", "pt\_brazil", "punjabi", "romanian", "russian", "serbian", "slovak", "slovenian", "spanish", "swahili", "swedish", "tagalog", "tamil", "telugu", "thai", "turkish", "ukrainian", "urdu", "vietnamese", "welsh", "yoruba", "zulu".
Text value.
Minimum length: 1. Maximum length: 1000000.
Optional at the transport boundary: the server injects an identifier before validation when omitted. Supply your own stable UUID v4 to recover safely from a lost response.
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}$`.
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": {
"projectId": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"pattern": "^[^/\\\\]+$"
},
"keepBackgroundMusic": {
"type": "boolean"
},
"keepOriginalVoice": {
"type": "boolean"
},
"originalVoiceVolume": {
"type": "number",
"minimum": 1,
"maximum": 70
},
"voiceMode": {
"type": "string",
"enum": ["cloning", "custom"]
},
"voiceId": {
"type": "string",
"minLength": 1,
"maxLength": 128
},
"subtitles": {
"type": "boolean"
},
"subtitlesSource": {
"type": "string",
"enum": ["translated", "original"]
},
"voiceIsolatorOption": {
"type": "string",
"enum": ["studio", "realistic"]
},
"lipSyncMode": {
"type": "string",
"enum": ["standard", "pro", "studio"]
},
"activeSpeakerDetectionEnabled": {
"type": "boolean"
},
"voiceCloningSettings": {
"type": "object",
"properties": {
"stability": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"similarity": {
"type": "number",
"minimum": 0,
"maximum": 1
}
},
"required": ["stability", "similarity"],
"additionalProperties": false
},
"translationTimeSkips": {
"maxItems": 100,
"type": "array",
"items": {
"type": "object",
"properties": {
"startTime": {
"type": "number",
"minimum": 0
},
"endTime": {
"type": "number",
"exclusiveMinimum": 0
}
},
"required": ["startTime", "endTime"],
"additionalProperties": false
}
},
"targetLanguage": {
"type": "string",
"enum": [
"afrikaans",
"albanian",
"amharic",
"arabic",
"armenian",
"assamese",
"azerbaijani",
"basque",
"belarusian",
"bengali",
"bosnian",
"bulgarian",
"catalan",
"croatian",
"czech",
"danish",
"dutch",
"english",
"british english",
"estonian",
"finnish",
"french",
"french canadian",
"galician",
"german",
"greek",
"gujarati",
"hebrew",
"hindi",
"hungarian",
"icelandic",
"indonesian",
"irish",
"italian",
"japanese",
"kannada",
"kazakh",
"khmer",
"korean",
"lao",
"latvian",
"lithuanian",
"macedonian",
"malay",
"malayalam",
"mandarin",
"marathi",
"mongolian",
"nepali",
"norwegian",
"persian",
"polish",
"portuguese",
"brazilian portuguese",
"pt_brazil",
"punjabi",
"romanian",
"russian",
"serbian",
"slovak",
"slovenian",
"spanish",
"swahili",
"swedish",
"tagalog",
"tamil",
"telugu",
"thai",
"turkish",
"ukrainian",
"urdu",
"vietnamese",
"welsh",
"yoruba",
"zulu"
]
},
"translatedSrt": {
"type": "string",
"minLength": 1,
"maxLength": 1000000
},
"requestId": {
"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}$",
"description": "UUID v4 for this action. Reuse the same ID with identical arguments on retries."
}
},
"required": ["projectId", "targetLanguage", "translatedSrt"],
"additionalProperties": false
}
```
## Idempotency
Use a UUID v4 in requestId or the Idempotency-Key HTTP header for each mutation. Reuse the same identifier and identical arguments after a network failure. If both are supplied, they must match. Replaying a saved request does not repeat the operation or charge another monthly call. Failed or interrupted requests are not restarted automatically.
Every mutation can return HTTP 202 when a retry finds the same request still running, even when its first execution is normally synchronous. If execution completed but resultStored is false, a retry returns HTTP 200 with saved request state instead of the original result. Retrieve the output through its domain history, result, or download action.
## 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/translations_dub' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"projectId":"project_launch_2026","targetLanguage":"english","voiceMode":"cloning","keepBackgroundMusic":true,"requestId":"41321bda-e243-4b6f-96a4-622cd047c991","translatedSrt":"1\n00:00:00,000 --> 00:00:02,000\nWelcome to the product launch.\n","subtitles":true,"subtitlesSource":"translated"}'
```
```javascript JavaScript theme={null}
const input = {
projectId: 'project_launch_2026',
targetLanguage: 'english',
voiceMode: 'cloning',
keepBackgroundMusic: true,
requestId: '41321bda-e243-4b6f-96a4-622cd047c991',
translatedSrt: '1\n00:00:00,000 --> 00:00:02,000\nWelcome to the product launch.\n',
subtitles: true,
subtitlesSource: 'translated',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/translations_dub', {
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/translations_dub",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"projectId": "project_launch_2026", "targetLanguage": "english", "voiceMode": "cloning", "keepBackgroundMusic": True, "requestId": "41321bda-e243-4b6f-96a4-622cd047c991", "translatedSrt": "1\n00:00:00,000 --> 00:00:02,000\nWelcome to the product launch.\n", "subtitles": True, "subtitlesSource": "translated"},
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.
Returns the project and language-work identifiers after admitting speech generation from caller-supplied target-language SRT.
```json HTTP 200 theme={null}
{
"data": {
"success": true,
"message": "Dubbing started successfully from the provided translation. Use the status endpoint to track progress.",
"projectId": "project_launch_2026",
"estimatedDuration": 10,
"workId": "5f8423d1-e4c0-4f80-9e3f-eed959389e24"
},
"requestId": "41321bda-e243-4b6f-96a4-622cd047c991"
}
```
```json HTTP 202 replay_running theme={null}
{
"data": {
"requestId": "41321bda-e243-4b6f-96a4-622cd047c991",
"operation": "translations_dub",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "running",
"pollAfterSeconds": 5
},
"requestId": "41321bda-e243-4b6f-96a4-622cd047c991"
}
```
```json HTTP 200 replay_completed_without_result theme={null}
{
"data": {
"requestId": "41321bda-e243-4b6f-96a4-622cd047c991",
"operation": "translations_dub",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "completed",
"resultStored": false,
"message": "The action completed. Retrieve its output from the corresponding history or resource action."
},
"requestId": "41321bda-e243-4b6f-96a4-622cd047c991"
}
```
## Result fields
| Field | Description |
| - | - |
| `data.success` | True when the background workflow was admitted; it does not indicate completed media. |
| `data.message` | Translation or supplied-translation dubbing acknowledgement. |
| `data.projectId` | Parent project identifier. |
| `data.estimatedDuration` | Rough processing estimate in minutes: ceil(source duration in seconds / 60) \* 5. |
| `data.workId` | Existing or newly created target-language work identifier. |
## Recover and poll this request
Use the same identifier even after a lost connection. If resultStored is false, retrieve the output through the corresponding history, result, or download action. Never start a second generation merely to check progress.
```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":"41321bda-e243-4b6f-96a4-622cd047c991","operation":"translations_dub"}'
```
```json HTTP 200 theme={null}
{
"data": {
"requestId": "41321bda-e243-4b6f-96a4-622cd047c991",
"operation": "translations_dub",
"status": "completed",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"resultStored": true,
"result": {
"success": true,
"message": "Dubbing started successfully from the provided translation. Use the status endpoint to track progress.",
"projectId": "project_launch_2026",
"estimatedDuration": 10,
"workId": "5f8423d1-e4c0-4f80-9e3f-eed959389e24"
}
}
}
```
## Operation notes
* translatedSrt is required and must contain valid SRT cues. This action requires a completed original transcript. Cues match the existing source segments by start time within 0.05 seconds, falling back to the largest time overlap; output timing always uses the original segment timeline.
* The target-language work is reused or created. The supplied text is dubbed without automatic translation or SmartSync.
* No source media is re-uploaded. The stored project provides duration and audio/video type.
* This action does not accept sourceSrt, fileKey, a media URL, or webhookUrl.
* voiceMode defaults to cloning. With voiceMode custom, use a catalog voice or a custom voice saved by the authenticated account; do not supply voiceCloningSettings. Team billing does not grant access to another member's saved voices.
* Optional subtitles, lipSyncMode, and translationTimeSkips require video input. Skipped ranges must remain within media duration, keepBackgroundMusic must be true, and keepOriginalVoice must be false.
* lipSyncMode accepts standard, pro, or studio, subject to the plan and normal media-credit checks. Speech and lip sync do not become free because monthly API calls are unlimited.
* Poll projects\_status for the media workflow; fetch all language versions with projects\_get.
* A cue with no matching source segment or a source segment without supplied text can fail the background pipeline; inspect projects\_status.error or projects\_get translations after admission.
## 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 | `DURATION_DETECTION_FAILED` | The stored project media duration is unavailable. |
| 400 | `IDEMPOTENCY_CONFLICT` | The Idempotency-Key header and requestId body field must match. |
| 400 | `INVALID_REQUEST_ID` | Supply a UUID v4 requestId or Idempotency-Key. |
| 400 | `INVALID_TRANSLATED_SRT` | The supplied target-language SRT is malformed. |
| 400 | `LIPSYNC_NOT_AVAILABLE_FOR_AUDIO` | Lip sync requires video input. |
| 400 | `LIPSYNC_VIDEO_TOO_LONG` | The video exceeds the selected lip-sync mode duration limit. |
| 400 | `SUBTITLES_NOT_AVAILABLE_FOR_AUDIO` | Burned-in subtitles require video input. |
| 400 | `TRANSLATION_TIME_SKIP_CONFLICT` | Translation time skips cannot be combined with keepOriginalVoice true. |
| 400 | `TRANSLATION_TIME_SKIP_NOT_AVAILABLE_FOR_AUDIO` | Translation time skips require video input. |
| 400 | `TRANSLATION_TIME_SKIP_OUT_OF_RANGE` | A skipped range extends past the media duration. |
| 400 | `TRANSLATION_TIME_SKIP_REQUIRES_BACKGROUND` | Translation time skips require keepBackgroundMusic true. |
| 400 | `VALIDATION_ERROR` | Correct the input using the schema. Invalid or inconsistent values are rejected before execution. |
| 400 | `VOICE_CLONING_SETTINGS_NOT_ALLOWED` | voiceCloningSettings apply only to voiceMode cloning. |
| 400 | `VOICE_ID_NOT_ALLOWED_WITH_CLONING` | voiceId cannot be combined with voiceMode cloning. |
| 400 | `VOICE_ID_REQUIRED` | voiceMode custom requires voiceId. |
| 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 | `ACCOUNT_UNAVAILABLE` | The acting or billing account is unavailable or being deleted. |
| 403 | `AMBIGUOUS_TEAM_API_KEY` | The credential's user belongs to more than one team, so the billing context is ambiguous. |
| 403 | `CUSTOM_VOICE_ACCESS_DENIED` | The selected voice is neither a catalog voice nor a custom voice saved by the authenticated account. |
| 403 | `FORBIDDEN` | The authenticated actor cannot access this project. |
| 403 | `INSUFFICIENT_CREDITS` | The account has insufficient media credits for the selected speech and optional lip-sync settings. |
| 403 | `INSUFFICIENT_SCOPE` | Grant every required permission or choose another credential. |
| 403 | `INTEGRATION_PLAN_UNSUPPORTED` | The account's integration limits could not be verified. |
| 403 | `LIPSYNC_MODE_ACCESS_DENIED` | The selected optional lip-sync mode is unavailable on the current plan. |
| 403 | `SUBSCRIPTION_REQUIRED` | Use an active paid subscription. |
| 403 | `TEAM_OWNER_NOT_FOUND` | The effective team owner account could not be found. |
| 404 | `PROJECT_NOT_FOUND` | The project does not exist in the accessible account. |
| 409 | `CONCURRENT_ACTION_LIMIT_REACHED` | This account already has 10 integration actions running. Poll an existing request before starting another. |
| 409 | `DUB_ONLY_REQUIRES_TRANSCRIPTION` | Wait for a completed, nonempty original transcription before starting this action. |
| 409 | `IDEMPOTENCY_CONFLICT` | Reuse an identifier only with the same operation and arguments. |
| 409 | `TRANSLATION_ALREADY_IN_PROGRESS` | A dubbing run for this target language is already in progress. |
| 429 | `CONCURRENT_TRANSLATION_LIMIT_REACHED` | The account has reached its concurrent translation limit. |
| 429 | `INTEGRATION_MONTHLY_LIMIT_REACHED` | Wait for the monthly reset or change plan. |
| 429 | `INTEGRATION_RATE_LIMIT_REACHED` | Wait for Retry-After when present and use backoff. |
| 500 | `INTERNAL_ERROR` | Check saved request state and resource history before deciding to retry a mutation. |
| 503 | `ACTION_RESULT_UNAVAILABLE` | The action ran but its result could not be saved. Inspect saved request state and resource history before starting a new generation. |
| 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": ["translations:write"]
}
}
```
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.