ElevenAPIDubbingLanguage targets

Create language target

Queue a language target for a project (starts once the project is ready).

Path parameters

project_idstringRequired
Identifier of the parent dubbing project.

Headers

xi-api-keystringOptional

Request

This endpoint expects an object.
target_languagestringRequired

BCP-47 language tag to dub the project into (e.g. ‘fr’, ‘es-MX’); must be a language the dubbing model supports. A region-qualified tag must be one of the supported dialects.

voice_settingsobject or nullOptional

Voice settings applied to the whole language (e.g. cloning strength).

translationsmap from strings to strings or nullOptional

Optional translations to use instead of machine translation. A map from each source segment’s external_id (or its id, if you supplied none) to the translated text; every source segment must be covered exactly once. At most 20000 entries, totalling at most 4 MiB of text.

Response

Successful Response
language_idstring
Unique identifier of the language target.
project_idstring
Identifier of the parent dubbing project.
target_languagestring

BCP-47 language tag this target is dubbed into.

statusenum

Lifecycle status: ‘queued’ (waiting on the project), ‘processing’, ‘completed’, ‘stale’ (source/transcript changed), or ‘failed’.

revisioninteger

Monotonic counter incremented whenever this target’s transcript changes (a source edit affecting it, or an edit to its translation).

created_atstringformat: "date-time"
When the language target was created.
updated_atstringformat: "date-time"
When the language target was last updated.
model_idstring or nullOptional

Effective dubbing model id (target override or project default).

voice_settingsobject or nullOptional
Voice settings applied to the whole language, or null if unset.
outputsobject or nullOptional

Signed output URLs; null until the target has produced an output (present once ‘completed’, and kept while ‘stale’ — compare output_revision against revision to tell whether the output is up to date).

output_revisioninteger or nullOptional

The revision the current dubbed output was generated from; equal to revision when up to date, less than it when ‘stale’. Null until a generation has completed.

errorobject or nullOptional

Why this language failed; null unless status is ‘failed’, and also null for the few languages that failed before failure reporting was introduced. A code of ‘project_failed’ means the parent project failed, so read the project for the underlying cause.

warningslist of objectsOptional

Non-fatal conditions raised while dubbing this language, empty when there are none. Reflects the latest generation. Conditions raised while preparing the source are reported on the project instead.

Errors

422
Unprocessable Entity Error