Skip to main content
PUT
/
voices
/
{id}
Update an existing voice by its ID
curl --request PUT \
  --url https://api.callers.ai/voices/{id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "isMultilingual": true,
  "supportedLocales": [],
  "settings": {
    "stability": 0.5,
    "similarity_boost": 0.75,
    "speed": 0
  }
}
'
import requests

url = "https://api.callers.ai/voices/{id}"

payload = {
"name": "<string>",
"isMultilingual": True,
"supportedLocales": [],
"settings": {
"stability": 0.5,
"similarity_boost": 0.75,
"speed": 0
}
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'PUT',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
isMultilingual: true,
supportedLocales: [],
settings: {stability: 0.5, similarity_boost: 0.75, speed: 0}
})
};

fetch('https://api.callers.ai/voices/{id}', 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.callers.ai/voices/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'isMultilingual' => true,
'supportedLocales' => [

],
'settings' => [
'stability' => 0.5,
'similarity_boost' => 0.75,
'speed' => 0
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);

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

curl_close($curl);

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

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

func main() {

url := "https://api.callers.ai/voices/{id}"

payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"isMultilingual\": true,\n \"supportedLocales\": [],\n \"settings\": {\n \"stability\": 0.5,\n \"similarity_boost\": 0.75,\n \"speed\": 0\n }\n}")

req, _ := http.NewRequest("PUT", url, payload)

req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")

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

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

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.put("https://api.callers.ai/voices/{id}")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"isMultilingual\": true,\n \"supportedLocales\": [],\n \"settings\": {\n \"stability\": 0.5,\n \"similarity_boost\": 0.75,\n \"speed\": 0\n }\n}")
.asString();
require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"isMultilingual\": true,\n \"supportedLocales\": [],\n \"settings\": {\n \"stability\": 0.5,\n \"similarity_boost\": 0.75,\n \"speed\": 0\n }\n}"

response = http.request(request)
puts response.read_body
{
  "id": "<string>",
  "voiceId": "<string>",
  "name": "<string>",
  "isMultilingual": true,
  "supportedLocales": [
    "<string>"
  ],
  "ttsClient": "<string>",
  "organizationId": "<string>",
  "settings": {
    "stability": 0.8,
    "style": 0.3
  }
}
{
"status": "error",
"message": "<string>",
"data": [
{}
]
}
{
"status": "error",
"message": "<string>"
}
{
"status": "error",
"message": "<string>"
}

Authorizations

Authorization
string
header
required

Headers

x-sub-organization-id
string

Optional sub organization ID. Must belong to your main organization API key.

Path Parameters

id
string
required

ID of the voice to update

Pattern: ^[0-9a-fA-F]{24}$

Body

application/json

Payload for updating the voice

name
string
Minimum string length: 5
isMultilingual
boolean
supportedLocales
enum<string>[]
Available options:
en-US,
en-GB,
en-AU,
en-CA,
en-IE,
en-IN,
en-NZ,
en-ZA,
en-SG,
es-ES,
es-MX,
fr-FR,
pt-BR,
pt-PT,
zh-CN,
cmn-EN,
nl-NL,
fi-FI,
de-DE,
de-AT,
de-CH,
de-LU,
de-LI,
gsw-CH,
gsw-LI,
el-GR,
hi-IN,
en-TA,
id-ID,
it-IT,
ja-JP,
ko-KR,
ms-MY,
en-MS,
ro-RO,
ru-RU,
uk-UA,
ka-GE,
bg-BG,
cs-CZ,
da-DK,
pl-PL,
sk-SK,
sv-SE,
tr-TR,
ar-SA,
ary-MA,
arz-EG,
apc-LB,
apc-SY,
apc-PS,
apc-JO,
acm-IQ,
ar-AE,
afb-AE,
afb-BH,
afb-KW,
afb-QA,
afb-OM,
hr-HR,
hr-BA,
he-IL,
ur-PK,
hu-HU,
fil-PH,
th-TH,
vi-VN
settings
object
gender
enum<string>
Available options:
MALE,
FEMALE

Response

The updated Voice object

id
string
required

The ID of the voice

voiceId
string
required

The provider-specific voice ID

name
string
required

The name of the voice

isMultilingual
boolean
required

Indicates if the voice supports multiple languages

supportedLocales
string[]
required

Array of supported locale strings

ttsClient
string
required

Identifier for the TTS (text-to-speech) client

gender
enum<string>
required

The gender of the voice

Available options:
MALE,
FEMALE
organizationId
string

The organization ID that owns this voice

settings
object

Additional settings stored in JSON format

Example:
{ "stability": 0.8, "style": 0.3 }