Get project

Full project detail, including its language target ids.

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

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

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

source_languagestring or nullOptional

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

model_idstring or nullOptional
Default dubbing model id applied to this project's language targets.
mediaobject or nullOptional

Source media metadata; null until the project is ready.

language_idslist of stringsOptionalDefaults to []
Identifiers of the language targets created under this project.
webhook_idslist of stringsOptionalDefaults to []
Workspace webhooks notified when this project becomes ready or fails, and when any of its languages completes or fails.
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