Sign in
Dubbing

Create Dubbing Project

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

Returns as soon as the project record exists, before the source has been fetched: the project starts queued and reaches ready once its source has been transcribed. Creating a project does not dub anything — add a language target to it for each language you want, or pass target_language to queue the first one here.

Preparation can take minutes on a long source, so we recommend passing webhook_ids to be notified when the project turns ready or failed, rather than polling for it.

post/v1/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.

Response

Successful Response

project_idstring required

Unique identifier of the dubbing project.

status'queued' | 'preparing' | 'processing' | 'ready' | 'failed' required

Lifecycle status of the project: queued before the source is picked up, preparing while it is transcribed, ready once transcription is done and language targets can start, or failed. A project is never reported as processing — that value belongs to language targets.

referencestring nullable

The free-form string you supplied as reference when creating the project, or null if you supplied none.

source_languagestring nullable

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

model_idstring nullable

Dubbing model every language target of this project is dubbed with. Fixed at create time and not selectable per language.

language_idsstring[]

Identifiers of the language targets under this project. Populated when a single project is fetched, and on create when target_language creates one. Always empty in list responses — list the project's language targets instead.

webhook_idsstring[]

IDs of the workspace webhooks notified as this project and its languages reach ready, completed, or failed.

revisioninteger required

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

created_atstring date-time required

When the project was created.

updated_atstring date-time required

When the project was last updated.

Changes

Changed in 4 of the 28 revisions of this API.16

  • 57d56f34628a2See the full diff
    • ○

      added the new optional request property webhook_ids

      new-optional-request-property

    • ○

      added the optional property webhook_ids to the response with the 201 status

      response-optional-property-added

  • 1cae8adcc9652See the full diff
    • ○

      added the optional property error to the response with the 201 status

      response-optional-property-added

    • ○

      added the optional property warnings to the response with the 201 status

      response-optional-property-added

  • ebff0190de5c11See the full diff
    • ▲

      removed subschema #1 from the model_id request property anyOf list

      request-property-any-of-removed

    • ○

      added subschema #1 subschema #2 to the model_id request property anyOf list

      request-property-any-of-added

  • 72c54eba117e1See the full diff
    • ○

      added the new optional request property transcript

      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