Create Dubbing Language Target

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

project_idstring required

Identifier of the parent dubbing project.

xi-api-keystring nullable

Your API key. This is required by most endpoints to access our API programmatically. You can view your xi-api-key using the 'Profile' tab on the website.

Request body

target_languagestring required

BCP-47 language tag to dub the project into (e.g. 'fr', 'es-419').

model_id'dubbing_v2' nullable

Dubbing model id for this target; omit to use the project default.

translationsobject nullable

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 required

Unique identifier of the language target.

project_idstring required

Identifier of the parent dubbing project.

target_languagestring required

BCP-47 language tag this target is dubbed into.

status'queued' | 'processing' | 'completed' | 'stale' | 'failed' required

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

model_idstring nullable

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

revisioninteger required

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

output_revisioninteger nullable

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.

created_atstring date-time required

When the language target was created.

updated_atstring date-time required

When the language target was last updated.

v5

Create Dubbing Language Target

Path parameters

Headers

Request body

Response