Sign in
Dubbing

Create Dubbing Language Target

Add a language to dub a project into, and queue the dub.

This is the call that produces dubbed audio, and it is billed per generation. The target is created queued and starts as soon as the project is ready, so it can be added at any point after the project is created. It inherits the project's dubbing model and cannot pick another.

A project created with webhook_ids sends a dubbing_language_completed event carrying the output download URLs, so we recommend subscribing rather than polling this target to completion.

post/v1/dubbing/project/{project_id}/language

Path parameters

project_idstring required

Identifier of the parent dubbing project.

Identifier of the parent dubbing project.

Headers

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.

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 (for example, fr or es-MX). Must be one of the languages the project's dubbing model supports, and a region-qualified tag must be one of the supported dialects.

translationsobject nullable

Enterprise only. 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 20,000 entries, totaling at most 4 MiB of text. See Bring your own transcript.

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 to be ready, or on a worker), processing while it is being dubbed, completed once its output is available, stale when the transcript changed after the output was produced, or failed.

model_idstring nullable

Dubbing model this target is dubbed with, inherited from the project and not selectable per language.

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, and lower when stale. This is 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.

Changes

Changed in 3 of the 32 revisions of this API.13

  • 1cae8adcc9652See the full diff
    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

  • ebff0190de5c1See the full diff
    • ●

      removed the request property

      request-property-removed

  • 72c54eba117e1See the full diff
    • ○

      added the new optional request property

      new-optional-request-property

    This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog