Sign in

v1

latestOpenAPI 3.1.02026-07-265094114.0 KB
Voices

Update voice by ID

Update an existing voice by ID

patch/v1/tones/{toneId}

Path parameters

toneIdstring required
Example:ton_2ee766eaa4ef48e59da1d9602bfecf2d

The voice's unique ID

Request body

namestring

The friendly name of the voice.

valuestring

The voices's description.

metadataobject

An optional set of key-value pairs to attach any data you wish to the voice, in a structured format. You can specify up to 10 keys, with key names up to 40 characters long and values up to 500 characters long.

Example request

{
  "name": "It's-a me, Mario!",
  "value": "This voice is energetic, playful, and humorous, characterized by exclamations, wordplay, and a confident, charismatic character, with techniques including catchphrases, direct address, and hyperbole to engage and entertain the audience.",
  "settings": {
    "appVisibility": "visible"
  }
}

Response

Update an existing voice

requestIdstring
resourcestring

Example response

{
  "requestId": "bce766ea-a4ef-48e5-9da1-d9602bfecf2d",
  "resource": "tone",
  "data": {
    "name": "It's-a me, Mario!",
    "value": "This voice is energetic, playful, and humorous, characterized by exclamations, wordplay, and a confident, charismatic character, with techniques including catchphrases, direct address, and hyperbole to engage and entertain the audience.",
    "settings": {
      "appVisibility": "visible"
    },
    "id": "ton_2ee766eaa4ef48e59da1d9602bfecf2d",
    "createdAt": "2023-09-21T15:38:00.474Z",
    "updatedAt": "2023-09-21T15:38:00.474Z"
  }
}