ElevenAPIDubbing

Create project

Create a dubbing project from an uploaded file or a source URL.

Headers

xi-api-keystringOptional

Request

This endpoint expects a multipart form with multiple files.
filefileOptional

The source media file to dub. Provide this or source_url.

source_urlstring or nullOptional
Public URL to fetch the source media from. Provide this or file.
referencestring or nullOptional

Optional free-form string (max 500 characters) to identify the project on your end.

source_languagestring or nullOptional

BCP-47 language tag of the source media; must be a language the transcription model supports. Any region or script subtag is ignored, since transcription is per-language. Omit to auto-detect.

model_idenum or string or nullOptional

Default dubbing model id (‘dubbing_v1’ or ‘dubbing_v2’) for the project’s language targets; a target may override it. Omit to use the system default.

keytermslist of stringsOptional

Key terms to bias transcription/translation toward (e.g. product or brand names). At most 1000 terms; each term at most 50 characters and 5 words; the characters <>{}[]\ are not allowed.

webhook_idslist of stringsOptional

Ids of workspace webhooks to notify when this project becomes ready or fails, and when any of its languages completes or fails. At most 3; each must be a webhook configured in your workspace.

target_languagestring or nullOptional

Optional shortcut: also create a language target in this BCP-47 language, queued to start once the project is ready. Must be a language the dubbing model supports, and a region-qualified tag must be one of the supported dialects.

transcriptfileOptional

Optional JSON transcript to use instead of automatic transcription. When provided, source_language is required. Segments may include an optional external_id and an optional translation; if any segment includes a translation, target_language is required and every segment must include one (used to seed the target created via target_language).

Response

Successful Response
project_idstring
Unique identifier of the dubbing project.
statusenum

Lifecycle status of the project: ‘preparing’/‘processing’ while it transcribes, ‘ready’ once transcription is done, or ‘failed’.

revisioninteger

Monotonic counter incremented whenever the source transcript is edited (segment add/edit/delete).

created_atstringformat: "date-time"
When the project was created.
updated_atstringformat: "date-time"
When the project was last updated.
referencestring or nullOptional

Optional free-form string the customer can provide to identify the project on their end.

source_languagestring or nullOptional

BCP-47 language tag of the source media (null if auto-detected).

model_idstring or nullOptional
Default dubbing model id applied to this project's language targets.
mediaobject or nullOptional

Source media metadata; null until the project is ready.

language_idslist of stringsOptionalDefaults to []
Identifiers of the language targets created under this project.
webhook_idslist of stringsOptionalDefaults to []
Workspace webhooks notified when this project becomes ready or fails, and when any of its languages completes or fails.
errorobject or nullOptional

Why the project failed; null unless status is ‘failed’. Also null for the few projects that failed before failure reporting was introduced.

warningslist of objectsOptional

Non-fatal conditions raised while preparing the source, empty when there are none. Reflects the latest preparation. Conditions raised while dubbing a particular language are reported on that language instead.

Errors

422
Unprocessable Entity Error