Skip to main content
POST
audio.voice-settings.get

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

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

The ref returned by audio.voices.list, audio.voice.create or audio.voice.clone.

Pattern: ^(ref_[0-9A-HJKMNP-TV-Z]{26}|rh_[A-Za-z0-9_-]{24,1024})$

Response

The result

stability
number

How steady the voice is, 0 to 1. Lower is more expressive, higher is more even.

Required range: 0 <= x <= 1
similarity
number

How closely the voice sticks to the original sample, 0 to 1.

Required range: 0 <= x <= 1
style
number

How strongly the original speaking style is exaggerated, 0 to 1.

Required range: 0 <= x <= 1
speakerBoost
boolean

Whether the voice is boosted to sound more like the original speaker.

speed
number

Speaking speed, 0.7 to 1.2; 1 is normal.

Required range: 0.7 <= x <= 1.2