Skip to main content
POST
audio.voice.update

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 audio.voice.create or audio.voice.clone.

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

The voice's name, up to 100 characters.

Required string length: 1 - 100
description
string

What the voice sounds like. Replaces the old description.

Required string length: 20 - 1000
labels
object

Tags for the voice. Replaces the old tags.

samples
object[]

Uploaded recordings to add to the voice, 1 to 3, in total at most 10 MB.

Required array length: 1 - 3 elements
removeBackgroundNoise
boolean
default:false

Clean background noise from the added recordings. Costs more. Default false.

Response

The result

updated
boolean
required

Always true: the voice was changed.