Skip to main content
PATCH
/
v1
/
custom-voices
/
{voice_id}
Update cloned voice (partial update)
curl --request PATCH \
  --url https://supertoneapi.com/v1/custom-voices/{voice_id} \
  --header 'Content-Type: application/json' \
  --header 'x-sup-api-key: <api-key>' \
  --data '
{
  "name": "My Updated Voice",
  "description": "An updated warm and friendly voice for customer service"
}
'
import requests

url = "https://supertoneapi.com/v1/custom-voices/{voice_id}"

payload = {
"name": "My Updated Voice",
"description": "An updated warm and friendly voice for customer service"
}
headers = {
"x-sup-api-key": "<api-key>",
"Content-Type": "application/json"
}

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

print(response.text)
const options = {
method: 'PATCH',
headers: {'x-sup-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'My Updated Voice',
description: 'An updated warm and friendly voice for customer service'
})
};

fetch('https://supertoneapi.com/v1/custom-voices/{voice_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
package main

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

func main() {

url := "https://supertoneapi.com/v1/custom-voices/{voice_id}"

payload := strings.NewReader("{\n \"name\": \"My Updated Voice\",\n \"description\": \"An updated warm and friendly voice for customer service\"\n}")

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

req.Header.Add("x-sup-api-key", "<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))

}
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://supertoneapi.com/v1/custom-voices/{voice_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'My Updated Voice',
'description' => 'An updated warm and friendly voice for customer service'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-sup-api-key: <api-key>"
],
]);

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

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
HttpResponse<String> response = Unirest.patch("https://supertoneapi.com/v1/custom-voices/{voice_id}")
.header("x-sup-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"My Updated Voice\",\n \"description\": \"An updated warm and friendly voice for customer service\"\n}")
.asString();
{
  "voice_id": "voice_123456789",
  "name": "My Updated Voice",
  "description": "An updated warm and friendly voice for customer service"
}
{
"status": "error",
"message": {
"message": "Invalid API Key",
"error": "Unauthorized"
}
}
{
"status": "error",
"message": {
"message": "Voice not found",
"error": "Not Found"
}
}
{
"status": "error",
"message": {
"message": "Failed to convert text to speech",
"error": "Internal Server Error"
}
}
Updates metadata on an existing custom voice. The underlying voice model is not re-trained — only name and description can change.

Endpoint

PATCH https://supertoneapi.com/v1/custom-voices/{voice_id}

Path parameters

NameRequiredDescription
voice_idThe ID of the custom voice to edit.

Request body

FieldRequiredDescription
nameNew voice name. Max 100 characters.
descriptionNew description.
At least one field must be provided.

Notes

  • The voice_id does not change. Existing references remain valid.
  • Returns 403 Forbidden if the voice belongs to a different account.

See also

Docs: Custom voices

Full custom-voice lifecycle.

Delete custom voice

Permanently remove a custom voice.

Authorizations

x-sup-api-key
string
header
required

Path Parameters

voice_id
string
required

Body

application/json
name
string

Name of the voice

Example:

"My Updated Voice"

description
string

Description of the voice

Example:

"An updated warm and friendly voice for customer service"

Response

Voice updated successfully

voice_id
string
required

Unique identifier for the voice

Example:

"voice_123456789"

name
string
required

Name of the voice

Example:

"My Updated Voice"

description
string | null

Description of the voice

Example:

"An updated warm and friendly voice for customer service"