Skip to main content
POST
Create a project from your uploaded fileKey, transcribe and translate it, then synthesize its speech. Supports caller SRT, voices, subtitles and optional lip sync. Uses the normal media credits. An optional webhookUrl receives processing events. Poll projects_status.

​
Authentication and permissions

​
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: projects:write, translations:write, transcription:write. An active paid subscription is required. Permissions do not change team roles, resource ownership, media credits, or plan limits.

​
Parameters

​
string
required
Text value.Minimum length: 1. Maximum length: 1024.
​
string
required
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”.
​
string
Text value.Allowed values: “af”, “sq”, “am”, “ar”, “hy”, “as”, “ast”, “az”, “ba”, “eu”, “be”, “bn”, “bs”, “br”, “bg”, “my”, “ca”, “ceb”, “zh”, “hr”, “cs”, “da”, “nl”, “en”, “eo”, “at”, “et”, “fil”, “fo”, “fi”, “fr”, “fr-CA”, “fy”, “ff”, “gd”, “gl”, “lg”, “ka”, “de”, “el”, “gu”, “ht”, “ha”, “haw”, “he”, “hi”, “hu”, “is”, “ig”, “ilo”, “id”, “ia”, “ga”, “it”, “ja”, “jv”, “kea”, “kn”, “kk”, “km”, “kur”, “kir”, “ko”, “lo”, “la”, “luo”, “lv”, “lb”, “ln”, “lt”, “mk”, “mg”, “ms”, “ml”, “mt”, “mi”, “mr”, “mo”, “mn”, “ne”, “no”, “nn”, “nso”, “nya”, “oc”, “or”, “pa”, “ps”, “fa”, “pl”, “pt”, “ro”, “ru”, “sa”, “sr”, “sn”, “sd”, “si”, “sk”, “sl”, “so”, “es”, “su”, “sw”, “ss”, “sv”, “tl”, “tg”, “ta”, “tt”, “te”, “th”, “bo”, “tn”, “tr”, “tk”, “ug”, “uk”, “umb”, “ur”, “uz”, “vi”, “cy”, “wo”, “xh”, “yi”, “yo”, “zu”, “cmn”, “yue”, “en-GB”, “en-US”, “en-AU”, “auto-detect”.
​
string
Text value.Minimum length: 1. Maximum length: 200.
​
string
Text value.Allowed values: “1”, “2”, “3”, “4”, “5”, “6”, “7”, “8”, “9”, “10”, “11”, “12”, “13”, “14”, “15”, “16”, “17”, “18”, “19”, “20”, “21”, “22”, “23”, “24”, “25”, “26”, “27”, “28”, “29”, “30”, “31”, “32”, “auto-detect”.
​
array
List of values. See the complete input schema for its item structure.Maximum items: 1000.
​
boolean
Boolean value.
​
string
Text value.Maximum length: 1000000.
​
string
Text value.Maximum length: 2048. Format: “uri”.
​
string
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}$.
​
boolean
Boolean value.
​
boolean
Boolean value.
​
number
Numeric value.Minimum: 1. Maximum: 70.
​
string
Text value.Allowed values: “cloning”, “custom”.
​
string
Text value.Minimum length: 1. Maximum length: 128.
​
boolean
Boolean value.
​
string
Text value.Allowed values: “translated”, “original”.
​
string
Text value.Allowed values: “studio”, “realistic”.
​
string
Text value.Allowed values: “standard”, “pro”, “studio”.
​
boolean
Boolean value.
​
object
JSON object. See the complete input schema for its nested fields.
​
array
List of values. See the complete input schema for its item structure.Maximum items: 100.
​
string
Text value.Maximum length: 1000000.
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.

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

​
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 a new project identifier after starting transcription followed by translation and speech generation, or supplied-translation dubbing.

​
Result fields

​
translatedSrt is supplied and accepted.

The same result fields acknowledge dubbing of the supplied target text.
HTTP 200

​
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.
HTTP 200

​
Operation notes

  • The completed fileKey must belong to the authenticated actor. The server measures the stored media duration and size.
  • An optional sourceSrt requires an explicit originalLanguage. When translatedSrt is also supplied, both SRTs must have the same cue count; the supplied translation is paired by cue index.
  • When translatedSrt is provided, the workflow dubs that text and returns the supplied-translation acknowledgement. With sourceSrt, cue alignment is by index; without sourceSrt it uses the automatic transcript timeline.
  • The creation result has no workId or translatedVersionId. Obtain those from projects_status or projects_get once they exist.
  • 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.
  • originalLanguage uses source-language codes such as fr or en (or auto-detect where accepted); targetLanguage uses supported target-language names such as english.

​
Usage

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

​
Errors