Skip to main content
POST
Design a voice from a prompt

Authorizations

Authorization
string
header
required

Use Authorization: Bearer pyai_live_... (or pyai_test_...).

Body

application/json
prompt
string
required

Natural-language description of the voice.

candidates
integer
default:3

How many candidate voices to generate.

Required range: 1 <= x <= 4
sample_text
string

Optional line the previews speak.

attributes
object

Optional structured hints folded into the prompt.

Response

Design job accepted

design_id
string
Example:

"dsn_a1b2c3"

status
string
Example:

"queued"

candidates
integer
Example:

3

estimated_seconds
integer
Example:

25