Get 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.

Path parameters

project_idstringRequired
Identifier of the dubbing project to fetch.

Headers

xi-api-keystringOptional

Response

Successful Response
project_idstring
Unique identifier of the dubbing project.
statusenum

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.

revisioninteger

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

created_atstringformat: "date-time"
When the project was created.
updated_atstringformat: "date-time"
When the project was last updated.
referencestring or nullOptional

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

source_languagestring or nullOptional

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

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

Source media metadata, populated once the source has been fetched and decoded (shortly after create, before the project is ready); null until then.

language_idslist of stringsOptionalDefaults to []

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_idslist of stringsOptionalDefaults to []

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

errorobject or nullOptional

Why the project failed; null unless status is failed. Also null for the few projects that failed before failure reporting was introduced.

warningslist of objectsOptional

Non-fatal conditions raised while preparing the source, empty when there are none. Reflects the latest preparation. Conditions raised while dubbing a particular language are reported on that language instead.

Errors

422
Unprocessable Entity Error