v4

latestOpenAPI 3.0.0raw.githubusercontent.com2026-05-23171869.8 KB
Voice

Update a voice prompt

Update metadata for an existing voice prompt. Only non-empty fields are updated — omit fields you don't want to change.

put/voice

Headers

x-api-keystring required

API Key

Request body

idstring required

Unique identifier for the voice prompt to update

namestring

New display name for the voice prompt

localestring

Language locale code

gender'MALE' | 'FEMALE' | 'NON_BINARY'

Gender of the speaker

ageinteger

Age of the speaker

Example request

{
  "id": "vp_12345abcde",
  "name": "Professional Female Voice",
  "locale": "en-US",
  "gender": "FEMALE",
  "age": 35
}

Response

Voice prompt updated successfully

Example response

{
  "prompt": {
    "id": "vp_12345abcde",
    "title": "Professional Narrator",
    "name": "Professional Female Voice",
    "locale": "en-US",
    "gender": "FEMALE",
    "speakingStyle": "narrative"
  }
}