Searches and retrieves voices provided by Supertone based on specified criteria.
| Parameter | Description | Example |
|---|---|---|
name | Search by voice name (partial match) | Coco |
language | Voice language code (multiple inputs possible with comma) | ko, en, ja |
gender | Voice gender (multiple inputs possible with comma) | male, female |
age | Voice age group | child, young-adult, middle-aged, elder, etc. |
use_case | Filter based on the primary use case | audiobook, narration, advertisement, etc. |
use_cases | Filter based on recommended use cases | audiobook, narration, advertisement, etc. |
style | Emotion style filter (The first value is the default) | neutral, happy, sad, angry, etc. |
description | Searchable by description (partial match) | kind and gentle, etc. |
model | Filter based on supported voice model | sona_speech_1, etc. |
page_size | Number of items per page (default: 20, max: 100) | 50 |
next_page_token | Token for pagination | nextPageToken value received from previous response |
⚠️ sort parameter is not supported.
next_page_token value can be obtained from the previous response.items array and next_page_token value, and also provides each voice’s voice_id, style, sample URL, etc.
Number of items per page (default: 20, min: 10, max: 100)
Token for pagination (obtained from the previous page's response)
Search across name. Space separated.
Search across description. Space separated.
Filter by language (comma-separated)
Filter by gender (comma-separated)
Filter by age (comma-separated)
Filter by use case (comma-separated)
Filter by use cases array (comma-separated for OR logic)
Filter by style (comma-separated for OR, semicolon-separated for AND). Mixing comma and semicolon is invalid and will result in 400. Note: AND semantics apply across styles on a single character; cloned voices have a single style and will only match AND when exactly one style is requested and equals the cloned voice style.
Filter by model (comma-separated)
Paginated available voices response with next page token
List of character items
Total number of available characters (might be approximate or removed in future)
150
Token for fetching the next page of results. Undefined if no more pages.
"some_opaque_token_string_representing_last_id"