Skip to main content
POST
audio.voice.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
ref
string
required

The ref returned by a preview of audio.voice.design.

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

The voice's name, up to 100 characters.

Required string length: 1 - 100
description
string
required

What the voice sounds like, 20 to 1000 characters.

Required string length: 20 - 1000
labels
object

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

Response

The result

name
string
required

The voice's name.

description
string

What the voice sounds like.

ref
string

Reference to what this call created. Pass it as ref to audio.voice.get, audio.voice.update, audio.voice.delete or audio.voice-settings.get.