Skip to main content
POST
audio.voice.clone

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
name
string
required

The voice's name, up to 100 characters.

Required string length: 1 - 100
samples
object[]
required

Uploaded recordings of the voice, 1 to 10. In total at most about two minutes and 30 MB.

Required array length: 1 - 10 elements
removeBackgroundNoise
boolean
default:false

Clean background noise from the recordings first. Costs more. Default false.

description
string

What the voice is.

Required string length: 1 - 1000
labels
object

Tags for the voice, such as {"accent": "british"}. At most 8.

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.