Skip to main content
POST
audio.voice.design

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

What the voice should sound like, 20 to 1000 characters, e.g. a calm middle-aged woman with a warm British accent.

Required string length: 20 - 1000
text
string

What each preview says, 100 to 1000 characters. Send this or autoGenerateText.

Required string length: 100 - 1000
autoGenerateText
boolean
default:false

Let the service write what the previews say. Default false.

quality
enum<string>
default:standard

Voice quality. High costs more. Default standard.

Available options:
standard,
high
loudness
number

Volume of the voice, -1 (quiet) to 1 (loud).

Required range: -1 <= x <= 1
seed
integer

The same seed and settings give the same previews.

Required range: 0 <= x <= 2147483647
guidance
number

How strictly the description is followed, 0 to 100.

Required range: 0 <= x <= 100
enhance
boolean

Let the service improve your description first.

reference
object

A recording whose style the voice should follow. Needs quality high.

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.