Skip to main content
GET
/
v1
/
custom-voices
Gets custom (cloned) voices
curl --request GET \
  --url https://supertoneapi.com/v1/custom-voices \
  --header 'x-sup-api-key: <api-key>'
import requests

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

headers = {"x-sup-api-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {'x-sup-api-key': '<api-key>'}};

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

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

func main() {

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

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

req.Header.Add("x-sup-api-key", "<api-key>")

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",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"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.get("https://supertoneapi.com/v1/custom-voices")
.header("x-sup-api-key", "<api-key>")
.asString();
{
  "items": [
    {
      "voice_id": "voice_123456789",
      "name": "My Custom Voice",
      "description": "A warm and friendly voice for customer service"
    }
  ],
  "total": 25,
  "next_page_token": "10"
}
{
"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"
}
}
Returns the custom voices owned by your account. This includes voice clones created in Supertone Play and clones created via Create cloned voice — both endpoints feed into the same list.

Endpoint

GET https://supertoneapi.com/v1/custom-voices

Query parameters

NameRequiredDescription
page_sizeItems per page. Default 20, max 100.
next_page_tokenToken from a previous response to fetch the next page.

Response

Returns an items array of custom voice objects plus an optional next_page_token.

Notes

  • Custom voices are account-scoped — you only see voices owned by the account whose API key is used.
  • Custom voices are callable through the same TTS endpoints as preset voices; just pass the custom voice_id.

See also

Docs: Custom voices

Create, manage, and use cloned voices.

Create cloned voice

Upload a sample to register a new clone.

Authorizations

x-sup-api-key
string
header
required

Query Parameters

page_size
number

Number of items per page (default: 20, min: 10, max: 100)

next_page_token
string

Token for pagination (obtained from the previous page's response)

Response

Paginated custom voices response with next page token

items
object[]
required

List of custom voice items

total
number
required

Total number of available custom voices

Example:

25

next_page_token
string

Token for fetching the next page of results. A valid non-negative integer string (e.g., "10", "20"). Null if no more pages.

Example:

"10"