v1

latestOpenAPI 3.0.02026-07-26152942.8 KB

voices

Search voices.

Search and filter voices based on various parameters.

get/v1/voices/search

Query parameters

page_sizenumber

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

next_page_tokenstring

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

namestring

Search across name. Space separated.

descriptionstring

Search across description. Space separated.

languagestring

Filter by language (comma-separated)

genderstring

Filter by gender (comma-separated)

agestring

Filter by age (comma-separated)

use_casestring

Filter by use case (comma-separated)

use_casesstring

Filter by use cases array (comma-separated for OR logic)

stylestring

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.

modelstring

Filter by model (comma-separated)

Response

Paginated available voices response with next page token

totalnumber required

Total number of available characters (might be approximate or removed in future)

next_page_tokenstring

Token for fetching the next page of results. Undefined if no more pages.

Example response

{
  "items": [
    {
      "voice_id": "<voice-id>",
      "name": "Agatha",
      "age": "young-adult",
      "gender": "female",
      "use_case": "narration",
      "use_cases": [
        "narration",
        "storytelling"
      ],
      "language": [
        "ar",
        "bg",
        "cs",
        "da",
        "de",
        "el",
        "en",
        "es",
        "et",
        "fi",
        "fr",
        "hi",
        "hu",
        "id",
        "it",
        "ja",
        "ko",
        "nl",
        "pl",
        "pt",
        "ro",
        "ru",
        "vi"
      ],
      "styles": [
        "kind-default",
        "normal",
        "serene"
      ],
      "models": [
        "sona_speech_1",
        "sona_speech_2",
        "sona_speech_2_flash",
        "supertonic_api_1",
        "supertonic_api_3"
      ],
      "samples": [
        {
          "language": "ko",
          "style": "kind-default",
          "model": "supertonic_api_3",
          "url": "https://example.com/samples/sample-audio.wav"
        }
      ],
      "thumbnail_image_url": "https://example.com/thumbnails/voice-thumbnail.png"
    }
  ],
  "total": 150,
  "next_page_token": "some_opaque_token_string_representing_last_id"
}