Skip to main content
PATCH
Update custom voice

Authorizations

Authorization
string
header
required

Your AI Reserve API key (aireserve_api_…) from the API Keys page in the portal (https://portal.aireserve.com/keys).

Path Parameters

voice_id
string
required

xAI custom voice id

Required string length: 1 - 255

Body

application/json

At least one field must be provided. All fields are optional; pass null to clear a nullable field.

name
string

New display name. Cannot be set to null.

Maximum string length: 255
description
string | null

Free-text description. Pass null to clear.

Maximum string length: 10000
gender
enum<string> | null

Speaker gender. Pass null to clear.

Available options:
male,
female,
neutral,
null
accent
string | null

Speaker accent (free text). Pass null to clear.

Maximum string length: 100
age
enum<string> | null

Approximate age bracket. Pass null to clear.

Available options:
young,
middle-aged,
old,
null
language
string | null

BCP-47 language code. Pass null to clear.

use_case
enum<string> | null

Intended use-case hint. Pass null to clear.

Available options:
conversational,
narration,
characters,
educational,
advertisement,
social_media,
entertainment,
null
tone
enum<string> | null

Tonal quality hint. Pass null to clear.

Available options:
warm,
casual,
professional,
friendly,
authoritative,
expressive,
calm,
null

Response

Updated custom voice.

Allowlisted projection of an xAI custom voice object returned by create, read, and update operations. xAI-internal fields (team IDs, consent state) are excluded.

voice_id
string
required
Pattern: ^[a-z0-9]{8}$
name
string | null
description
string | null
gender
string | null
accent
string | null
age
string | null
language
string | null
use_case
string | null
tone
string | null
created_at
string<date-time>