Skip to main content
POST
media.dubbing.create

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
targetLanguage
string
required

Language to dub into, e.g. es.

Pattern: ^[a-z]{2,3}$
fileId
string

Id of an uploaded file holding the audio or video to dub, in place of a public link.

Pattern: ^file_[0-9A-HJKMNP-TV-Z]{26}$
sourceUrl
string

Public https link to the audio or video to dub. Send this or fileId.

name
string

A name for the dubbing.

Required string length: 1 - 100
sourceLanguage
string

Language spoken in the source, e.g. en. Default: detected.

Pattern: ^[a-z]{2,3}$
durationLimitSeconds
integer
default:60

The most source time to dub, in seconds, 1 to 600. You are held for this much. Default 60.

Required range: 1 <= x <= 600
startSeconds
integer
default:0

Where in the source to start dubbing, in seconds. Default 0.

Required range: 0 <= x <= 9007199254740991
endSeconds
integer

Where in the source to stop, in seconds. Default: durationLimitSeconds after the start.

Required range: 1 <= x <= 9007199254740991
removeWatermark
boolean
default:false

Dub without a watermark. Costs more. Default false.

numSpeakers
integer

How many people speak, 0 to 32. Default 0: detected.

Required range: 0 <= x <= 32
highestResolution
boolean
default:false

Keep the source's full video resolution. Default false.

dropBackground
boolean
default:false

Remove background sound and music from the dub. Default false.

Response

Job started; poll GET /v1/jobs/{id}

job_id
string
required
status
enum<string>
required
Available options:
running
held_micro
integer
required

The credit set aside for the job (its estimate), micro-USD; 0 when it takes none. Not a price: what the job is charged reads on GET /v1/jobs/{id} once it is settled.