Documentation

Versions

versions

Methods

Get A Dubbing Version ->
DubbingVersion
get/v1/versions/{version_id}

Retrieve detailed information about a specific dubbing version by providing its unique Version ID.

Response Details

The response includes metadata about the version, such as its current status and progress in the dubbing process.

The studio_url field provides a link to Panjaya Dubbing Studio, where you can fine-tune the dubs further. This URL is not signed and requires authentication. Use the /studio_url endpoint (as described below) to pre-sign a URL.

If the final video has been successfully generated, the response will also include a signed URL in the result_url field. This URL allows you to securely download the fully synchronized video, complete with lip and body language alignment.

Version Status

The status field indicates the current state of the version. Possible values include:

  • NotReady: The version is currently being prepared for editing.
  • ReadyToEdit: The version is ready for editing and refinement in the Panjaya Dubbing Studio web interface.
  • Generating: The version is being processed to generate the final video. Editing is temporarily disabled during this stage.
  • Completed: The version has been successfully generated and is ready for download.
  • Failed: An error occurred during the version processing.
Revise Version -> { studio_url }
patch/v1/versions/{version_id}/revise

Revert a generated dubbing version to editing mode in the Panjaya Dubbing Studio.

Once a dubbing version is successfully generated, its status changes to Completed, allowing only preview access to the generated video. If further edits are needed, use this endpoint to restore the version to an editable state.

Note: This action permanently removes the generated video and its associated result_url.

If studio_url_request provided this endpoint will return a URL to the Panjaya Dubbing Studio. See the Create a signed URL endpoint for more details.

Version Status

This operation is only allowed if the version status is either Completed, ReadyToEdit or Failed. Upon execution, the version status will be updated to ReadyToEdit, allowing further modifications.

Generate Version -> unknown
post/v1/versions/{version_id}/generate

Initiate the generation process for a dubbing version. Once the process is complete, and you'll receive notifications via email or a callback URL, if configured (see below). Your final video will then be available for download.

Version Status

This operation is only allowed if the version status is ReadyToEdit. Upon execution, the version status will be updated to Generating, until the generation process is completed, after which the version status will be updated to Completed.

Create A Signed URL For Version -> { studio_url }
post/v1/versions/{version_id}/studio_url

Create a URL that allows anyone with the link to access the Panjaya Dubbing Studio for a specific dubbing version.

This endpoint is useful for sharing a version with collaborators or reviewers who need to make edits or QC the dubbing, without requiring them to log in.

The generated URL provides a pre-signed access to the Panjaya Dubbing Studio, where users can view the dubbing version, adjust the text, and fine-tune the dubbing. The access is limited to the specific version and does not allow access to other versions or assets.

Adjust the expiration_minutes parameter to specify the duration in minutes for which the URL will remain valid. The default expiration time is 3 hours.

Get A Version S Subtitles -> unknown
get/v1/versions/{version_id}/srt

Fetch the current version's source transcript or target translation, formatted as an SRT file.

Use the locality query parameter to indicate the desired subtitles - Set to source for fetching the transcript in the asset's source language, or target for fetching the current translation in the version's target language.

Domain types

DubbingVersion = { asset_id, created_at, dubbing_id, 8 more... }
VersionStudioURL = { expiration_minutes, sign_url }