POST
/
v1
/
voices
/
{voice_preset_id}
curl --request POST \
  --url https://api.bland.ai/v1/voices/{voice_preset_id} \
  --header 'Content-Type: application/json' \
  --header 'authorization: <authorization>' \
  --data '{
  "voice_name": "<string>",
  "description": "<string>",
  "voice_id": 123,
  "reduce_latency": true,
  "interruption_threshold": 123,
  "language": "<string>",
  "voice_settings": {}
}'
{
    "message": "Successfully updated voice preset with an id of 79698ec7-35c5-44ff-8ad8-2f63ec6104d3",
    "updates": {
        "description": "Twice as fast Matt!",
        "voice_settings": {
            "optimize_for": "quality",
            "interruption_threshold": 100
        }
    },
    "voice": {
        "voice_preset_id": "79698ec7-35c5-44ff-8ad8-2f63ec6104d3",
        "voice_name": "Fast Matt",
        "description": "Twice as fast Matt!",
        "reduce_latency": true,
        "language": "ENG",
        "voice_settings": "{\"optimize_for\":\"quality\",\"interruption_threshold\":100}",
        "editable": true,
        "public": false,
        "created_at": "2024-01-08T20:19:23.531924+00:00"
    }
}

Headers

authorization
string
required

Your API key for authentication.

Path Parameters

voice_preset_id
string
required

The id of the voice preset to update.

Note:

  • Public voices cannot be altered once published.

Request Body

voice_name
string

The name for the new voice preset.

description
string

A description of the voice preset.

voice_id
integer

The existing voice_id that will be mapped to the new voice preset.

reduce_latency
boolean

The current reduce_latency setting that will be mapped to the new voice preset.

interruption_threshold
integer
default: 50

The threshold for voice interruption settings.

Reset to default by setting to null.

language
string

The language code for the voice preset.

Reset to default by setting to null.

voice_settings
object

A JSON object containing specific settings for the voice.

Optional Settings:

  • speed - Multiplies the speed of the voice (only reduce_latency: true voices)
  • interruption_threshold - Delay before responding (in milliseconds)
  • stability - Lower for more emotion, higher for more stability
  • similarity - Match cloned voice more closely
  • speech_flexibility - Flexible pronunciation
  • optimize_for - speed_max, speed, quality, quality_max or null

Response

message
string

Confirmation message indicating successful update of the voice preset.

updates
object

Contains the details of the updates applied to the voice preset.

  • description - The updated description of the voice preset.
  • voice_settings - The updated voice settings, including optimization and interruption threshold.
voice
object

Contains detailed information about the updated voice preset.

  • voice_preset_id - The unique identifier for the voice preset.
  • voice_name - Public voice name.
  • description - The updated description of the voice preset.
  • reduce_latency - Whether or not the voice preset is optimized for low latency.
  • interruption_threshold - The updated threshold for the voice preset to be interrupted by a new message.
  • language - The language code of the voice preset.
  • voice_settings - The updated voice settings of the voice preset.
  • editable - Whether or not your account can edit the preset.
  • public - Whether or not the preset is publicly available.
  • created_at - The date and time the preset was originally created.