Sign in
Dubbing

Get Dubbing Project

Full project detail, including the IDs of every language target under it. To follow a project to ready, we recommend a webhook_ids subscription rather than polling this endpoint.

get/v1/dubbing/project/{project_id}

Path parameters

project_idstring required

Identifier of the dubbing project to fetch.

Identifier of the dubbing project to fetch.

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 2 of the 32 revisions of this API.3

  • 57d56f34628a1See the full diff
    • ○

      added the optional property to the response with the status

      response-optional-property-added

  • 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