Skip to main content
POST
This endpoint allows you to add a new video to an existing project. The video will be uploaded to the pipeline for processing.

​
Path Parameters

​
string
required
The unique identifier of the project.

​
Request Body

​
string
required
Name of the video.
​
string
required
Type of video processing (e.g., dubbing, voiceover, audio_description, transcription, translation, subtitling, tts).tts is the Voice lines workflow: there is no source video — a script is voiced line by line into separate audio files. See Voice lines below for what changes in the request.
​
string
Artifact ID of the source video (must be uploaded beforehand). Required for every workflow except tts, where it must be omitted — the script is the source.
​
string
required
Source language code in ISO 639-1 format (e.g., en, ru, de).You can also pass multi to enable multi-language source mode, where the source video contains speech in multiple languages. In this mode, the system will automatically detect the language of each segment.
The multi option must be enabled for your organization by an administrator. Contact your account manager to activate multi-language source support.
​
array
Optional list of source language codes in ISO 639-1 format (e.g., ["en", "ru", "de"]) to restrict automatic language detection to a known subset.Only allowed when sourceLanguage is multi. Omit the field to detect any supported language. When provided, it must be a non-empty array.
​
array
required
Array of target language codes in BCP 47 format — a combination of an ISO 639-1 language code and an ISO 3166-1 Alpha-2 region code (e.g., es-ES, fr-FR, en-US).
​
object
Attach a ready-made source script (the original-language transcript) instead of having it transcribed. Optional.
  • artifactId (string, required): Artifact ID of the uploaded script file. Must be an artifact of type script.
  • Optional import settings inline alongside artifactId.
See Attaching Scripts for supported formats, settings and examples.
​
object
Attach ready-made target scripts (finished translations) per language. Optional.An object where each key is a target language code that must be present in targetLanguages, and each value has the same shape as sourceScript.Accepted for dubbing, voiceover, audio_description and translation. See Attaching Scripts for details.
​
string
Artifact ID of the background audio (optional).
​
string
Artifact ID of the international mix audio (optional).
​
string
Artifact ID of the vocals HITL audio (optional).
The background, international mix and vocals audio must have same duration as the source video.
​
string
Additional remarks about the video (optional).
​
array
Optional array of key-value pairs for storing video metadata. Useful for storing external system references like backlinks, identifiers, or other custom metadata.Each item should be an object with key and value properties (both strings).Example:
​
string
Optional pivot (intermediate) language code in BCP 47 format (e.g., en-US).When set, translation goes through the pivot language first (e.g., ru → en-US → es-ES) instead of translating directly from source to each target language. This can improve translation quality for rare language pairs.Supported for dubbing, voiceover, translation, and subtitling workflow types. Not available for transcription and audio_description.When pivot language is used, original timings are automatically preserved (align step is skipped).
​
object
Pipeline configuration options (all fields optional):
  • shouldAutomateTranscription (boolean): Automatically transcribe the source video; not available with pivotLanguage
  • shouldAutomateTranslation (boolean): Automatically translate the transcription
  • shouldAutomateVoiceSelection (boolean): Automatically select voices for speakers
  • voiceSelectionMode (string): How voices are selected during automation. Requires shouldAutomateVoiceSelection: true. One of:
    • default — use library voices (default)
    • cloning — use voice cloning (ElevenLabs). All target languages must support cloning
    • emotion_transfer — use emotion transfer. Must be enabled for your organization, and all target languages must support it
    • label — use only voices with a specific label. Requires voiceSelectionVoicesLabel
  • voiceSelectionVoicesLabel (string): Voice label name to filter by. Required when voiceSelectionMode is label. The label must exist; a speaker the label has no matching voice for keeps a library voice
​
string
Voice lines only. Artifact ID of a references archive — a zip of recordings (.wav, .mp3, .m4a, .aac, .ogg, .flac, or video files) matched to script lines by their inputFileName column. Required for voiceSelectionMode cloning and emotion_transfer.
​
object
Subtitling parameters per destination language. Used only when workflowType is subtitling.This is an object where keys are language codes (e.g., ‘en-US’, ‘es-ES’) and values are objects with the following optional fields:
  • maxLinesPerSubtitle (number): Maximum number of lines per subtitle (default: 2, range: 1-5)
  • maxCharsPerLine (number): Maximum number of characters per line (CPL) (default: 30, range: 1-1000)
  • maxCharsPerSecond (number): Maximum reading speed in characters per second (CPS) (default: 20, range: 1-100)
  • minDurationMs (number): Minimum subtitle duration in milliseconds (default: 1000, range: 100-60000)
  • maxDurationMs (number): Maximum subtitle duration in milliseconds (default: 6000, range: 100-60000)
Example:
​
object
Extra translation guidance passed to the translation engine. Optional.
  • common (string): Guidance applied to all target languages.
  • byLang (object): Per-language guidance. Keys are target language codes (each must be present in targetLanguages), values are strings. The backend merges common first, then the language-specific prompt.
Example:
​
object
Advanced audio processing and export options applied when the video is rendered. All fields are optional; omit the field entirely to use the defaults.
  • exportTtsAaf (boolean): Export the synthesized speech in AAF format with separate audio tracks for each speaker (default: false).
  • channelPerSpeaker (boolean, deprecated): Place each speaker in a separate audio channel instead of mixing them into one (default: false). Use exportTtsAaf instead.
  • targetLoudness (number): Final loudness (LUFS) the output is normalized to (default: -23, per the EBU R128 standard).
  • ttsLoudness (number): Loudness (LUFS) of the synthesized speech handed to mixing (default: -23).
  • mixerCrossfadeMs (number): Crossfade duration in milliseconds at speech boundaries — controls how smooth or sharp audio transitions are (default: 300).
  • exportWavCodec (string): Audio codec for WAV export. One of pcm_s16le, pcm_s24le, pcm_s32le, pcm_f32le, pcm_f64le (default: pcm_s16le).
  • exportWavRate (number): Sample rate in Hz for exported WAV files, e.g. 44100, 48000 (default: 44100).
  • voiceoverMuffleDb (number): How much (dB) to lower the original audio where synthesis is overlaid in voiceover mode. Higher values make the original quieter (default: 9).
  • backgroundMuffleDb (number): How much (dB) to lower the background track in voice-replacement mode. Applied only when a background track is provided (default: 7).
  • voiceoverFixVocalsVolume (boolean): Lower the on-screen speech across the whole track (by voiceoverMuffleDb), not only where synthesis is applied (default: false).
  • voiceoverFixBackgroundVolume (boolean): Keep the background at full volume and lower only the original speech by voiceoverMuffleDb when overlaying synthesis (default: true).
  • transferVoiceLoudness (boolean): Transfer the loudness of the separated original speech onto the synthesized speech, segment by segment (default: false).
  • useBackgroundNorm (boolean): Normalize the loudness of the background track (default: false).
Example:
If you automate transcription, you won’t be able to edit the generated transcription in the future. The transcription phase will be skipped, and the result of the AI’s work will be used.

​
Response

​
string
Unique identifier of the created video.
​
string
URL to the created video resource.
​
string
Name of the video.
​
string
Status of the video (e.g., ‘new’).
​
string
Type of the video processing (e.g., ‘dubbing’).
​
string
Source language code.
​
array
Array of target language codes.
​
string | null
Pivot language code, if set.
​
number
Duration of the video in seconds (if available).
​
string
Additional remarks about the video (if any).
​
array | null
Array of key-value pairs containing video metadata, if provided.
​
object | null
The translation guidance stored for the video (common and/or byLang), or null if not set.
​
string
ISO timestamp of creation.
​
string
ISO timestamp of last update.
Video creation is rate limited per organization. Over the limit the endpoint returns 429 with a Retry-After header. See Rate Limiting.

​
Audio description

An audio_description video is voiced by a single narrator. The narrator voice is always selected automatically: there is no voice selection task to assign. Compared to the other workflows:

​
Voice lines

A tts video takes a script instead of a video and delivers one audio file per line (or per outputFileName group), packed as tts.zip. Compared to the other workflows: Credits are charged by the number of characters in the script at creation. Voices are selected and the script is rendered automatically; poll Get Project Video Status until the rendering phase rests on editor, then fetch tts.zip from List Translation Export Files for the video’s language.
The Voice lines workflow must be enabled for your organization. Contact your account manager to activate it.