Get Voice Settings

curl --request GET \
  --url https://api.bland.ai/v1/voices/{id}/settings \
  --header 'authorization: <authorization>'

const options = {method: 'GET', headers: {authorization: '<authorization>'}};

fetch('https://api.bland.ai/v1/voices/{id}/settings', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.bland.ai/v1/voices/{id}/settings",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "authorization: <authorization>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.bland.ai/v1/voices/{id}/settings"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("authorization", "<authorization>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.bland.ai/v1/voices/{id}/settings")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["authorization"] = '<authorization>'

response = http.request(request)
puts response.read_body

{
  "consistency": 8,
  "expressiveness": 1,
  "service": "BTTS_V2",
  "limits": {
    "consistency": { "min": 0, "max": 64 },
    "expressiveness": { "min": 0, "max": 1 }
  }
}

{
  "boost_language_consistency": true,
  "service": "BTTS_V3"
}

{
  "data": null,
  "errors": [
    { "error": "VOICE_SETTINGS_ERROR", "message": "Voice is a default voice and not owned by the user." }
  ]
}

GET

voices

{id}

settings

Get Voice Settings

curl --request GET \
  --url https://api.bland.ai/v1/voices/{id}/settings \
  --header 'authorization: <authorization>'

const options = {method: 'GET', headers: {authorization: '<authorization>'}};

fetch('https://api.bland.ai/v1/voices/{id}/settings', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.bland.ai/v1/voices/{id}/settings",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "authorization: <authorization>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.bland.ai/v1/voices/{id}/settings"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("authorization", "<authorization>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.bland.ai/v1/voices/{id}/settings")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["authorization"] = '<authorization>'

response = http.request(request)
puts response.read_body

{
  "consistency": 8,
  "expressiveness": 1,
  "service": "BTTS_V2",
  "limits": {
    "consistency": { "min": 0, "max": 64 },
    "expressiveness": { "min": 0, "max": 1 }
  }
}

{
  "boost_language_consistency": true,
  "service": "BTTS_V3"
}

{
  "data": null,
  "errors": [
    { "error": "VOICE_SETTINGS_ERROR", "message": "Voice is a default voice and not owned by the user." }
  ]
}

Overview

Returns the current synthesis defaults stored on a voice you own, plus the valid range for each tunable so callers do not have to discover the bounds by trial and error. Different engines expose different settings:

BTTS V1: consistency (0-1 float) and expressiveness (0-1 float).
BTTS V2: consistency (0-64 integer, lower is more consistent) and expressiveness (0-1 float).
BTTS V3: a single boolean boost_language_consistency.

To update these settings, use Update Voice Settings.

Headers

string

required

Your API key for authentication.

Path Parameters

string

required

UUID of the voice.

Response

For V1 and V2 voices:

number

string

The engine identifier, e.g. BTTS_V2.

object

Valid ranges for the tunables.

Show limits fields

number

1 for V1, 64 for V2.

number

For V3 voices:

boolean

string

BTTS_V3.

{
  "consistency": 8,
  "expressiveness": 1,
  "service": "BTTS_V2",
  "limits": {
    "consistency": { "min": 0, "max": 64 },
    "expressiveness": { "min": 0, "max": 1 }
  }
}

{
  "boost_language_consistency": true,
  "service": "BTTS_V3"
}

{
  "data": null,
  "errors": [
    { "error": "VOICE_SETTINGS_ERROR", "message": "Voice is a default voice and not owned by the user." }
  ]
}

Docs for agents: llms.txt

Get Started

Realtime Speech

HTTP Speech

Migrate

Voice Cloning

Voices

Discovery

Samples

Generation History

Models

Tooling

Get Voice Settings

Overview

Headers

Path Parameters

Response

​Overview

​Headers

​Path Parameters

​Response

Overview

Headers

Path Parameters

Response