Get Project

Retrieve details of a specific project

cURL

curl -X GET https://app.dubformer.ai/api/v1/projects/{project_id} \
  -H "Authorization: Bearer YOUR_API_KEY"

Path Parameters

project_id · string · required

The unique identifier of the project to retrieve.

Response

The response format varies depending on the project status.

Common Fields

name · string

Name of the project.

source_lang · string

Source language of the video.

target_lang · string

Target language for dubbing.

mixing_mode · string

Audio mixing mode used for the project.

cost_minutes · number

Number of minutes charged for this project.

created_date · string

ISO timestamp when the project was created.

status · string

Current status: in_progress, ready, or error.

Ready Project Fields

completion_date · string

ISO timestamp when processing completed.

output_video_url · string

Download URL for the dubbed video file.

output_tts_audio_url · string

Download URL for the dubbed audio track.

output_source_script · array

Array of source language script segments with timing information.

Show Script Object Properties

start_ms · number

Start time in milliseconds.

end_ms · number

End time in milliseconds.

text · string

Text content of the segment.

speaker_id · number

Unique identifier for the speaker.

output_target_script · array

Array of target language script segments with timing information. Uses the same structure as output_source_script.

output_target_speakers · array

Array of speaker configurations used for dubbing.

Show Speaker Object Properties

speaker_id · number

Unique identifier for the speaker.

voice_key · string

Voice identifier used for this speaker.

style · string

Voice style: masculine or feminine.

In Progress Project Fields

estimated_completion_date · string

ISO timestamp of estimated completion time.

Error Project Fields

error_message · string

Description of the error that occurred during processing.

Ready Project

{
  "name": "My Project",
  "source_lang": "en",
  "target_lang": "fr-FR", 
  "mixing_mode": "voiceover_with_original_track",
  "cost_minutes": 10,
  "created_date": "2024-06-01T12:00:00Z",
  "status": "ready",
  "completion_date": "2024-06-02T12:00:00Z",
  "output_video_url": "https://example.com/output_video.mp4",
  "output_tts_audio_url": "https://example.com/output_tts_audio.wav",
  "output_source_script": [
    {
      "start_ms": 100,
      "end_ms": 1544,
      "text": "Hello world!",
      "speaker_id": 1
    }
  ],
  "output_target_script": [
    {
      "start_ms": 100,
      "end_ms": 1544,
      "text": "Bonjour le monde!",
      "speaker_id": 1
    }
  ],
  "output_target_speakers": [
    {
      "speaker_id": 1,
      "voice_key": "voice:Rachel",
      "style": "feminine"
    }
  ]
}

In Progress Project

{
  "name": "My Project",
  "source_lang": "en",
  "target_lang": "fr-FR",
  "mixing_mode": "voiceover_with_original_track",
  "cost_minutes": 10,
  "created_date": "2024-06-01T12:00:00Z",
  "status": "in_progress",
  "estimated_completion_date": "2024-06-05T12:00:00Z"
}

Error Project

{
  "name": "My Project",
  "source_lang": "en",
  "target_lang": "fr-FR",
  "mixing_mode": "voiceover_with_original_track",
  "cost_minutes": 10,
  "created_date": "2024-06-01T12:00:00Z",
  "status": "error",
  "error_message": "An error occurred during processing."
}