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

name
string
required

The voice's name.

category
enum<string>
required

A shared voice, or one you created.

Available options:
preset,
custom
description
string

What the voice sounds like.

languages
string[]

Languages the voice is verified for.

labels
object

The tags you gave the voice.

sampleCount
number

How many audio samples the voice was made from.

settings
object

How the voice speaks.