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": "voice_123456789",
      "name": "My Custom Voice",
      "description": "A warm and friendly voice for customer service"
    }
  ],
  "total": 25,
  "next_page_token": "10"
}

Documentation Index

Fetch the complete documentation index at: https://docs.supertoneapi.com/llms.txt

Use this file to discover all available pages before exploring further.

Returns custom voices on your account that match the given filters.

Endpoint

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

Query parameters

NameDescriptionExample
nameVoice name, partial match.narrator
descriptionDescription, partial match.kind and gentle
page_sizeItems per page. Default 20, max 100.50
next_page_tokenToken from a previous response.eyJpZCI6IjEyMzQ1In0=

Response

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

See also

Docs: Custom voices

Full lifecycle: create, list, search, update, delete.

List custom voices

Get all custom voices without filtering.

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"