Sign in

v9

OpenAPI 3.1.02026-08-073641,4011.9 MB
Dubbing

Create Dubbing Project

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

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: 'preparing'/'processing' while it transcribes, 'ready' once transcription is done, or 'failed'.

referencestring nullable

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

source_languagestring nullable

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

model_idstring nullable

Default dubbing model id applied to this project's language targets.

language_idsstring[]

Identifiers of the language targets created under this project.

webhook_idsstring[]

Workspace webhooks notified when this project becomes ready or fails, and when any of its languages completes or fails.

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.