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: <x-sup-api-key>'
{
  "items": [
    {
      "voice_id": "<string>",
      "name": "<string>",
      "description": "<string>"
    }
  ],
  "total": 25,
  "nextPageToken": "10"
}
An API that allows you to search for voices based on specific conditions.
You can filter the customer registered voices available in your account by various criteria such as name and description.

โ€‹
Key Parameters

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

Headers

โ€‹
x-sup-api-key
string
required

API key for the service

Query Parameters

โ€‹
page_size
number

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

โ€‹
name
string

Search across name. Space separated.

โ€‹
description
string

Search across description. Space separated.

โ€‹
next_page_token
string

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

Response

200
application/json

Paginated custom voices search response with next page token

The response is of type object.