Skip to main content
GET
/
v1
/
custom-voices
/
search
Search custom (cloned) voices
curl --request GET \
  --url https://supertoneapi.com/v1/custom-voices/search \
  --header 'x-sup-api-key: <api-key>'
{
  "items": [
    {
      "voice_id": "<string>",
      "name": "<string>",
      "description": "<string>"
    }
  ],
  "total": 25,
  "next_page_token": "10"
}
You can filter customer registered voices available in your account by various conditions such as name, language, style, etc.

โ€‹
Endpoint

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

โ€‹
Key Parameters

ParameterDescriptionExample
nameSearch by voice name (partial match)My cloned voice 1
descriptionSearch by description (partial match)kind and gentle, etc.

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)

โ€‹
name
string

Search across name. Space separated.

โ€‹
description
string

Search across description. Space separated.

Response

Paginated custom voices search 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"