GET
/
v1
/
voices
/
search
Search voices.
curl --request GET \
  --url https://supertoneapi.com/v1/voices/search \
  --header 'x-sup-api-key: <x-sup-api-key>'
{
  "items": [
    {
      "voice_id": "<voice-id>",
      "name": "Agatha",
      "description": "",
      "age": "young-adult",
      "gender": "female",
      "use_case": "narration",
      "use_cases": [
        "narration",
        "storytelling"
      ],
      "language": [
        "ko",
        "en",
        "ja"
      ],
      "styles": [
        "kind-default",
        "normal",
        "serene"
      ],
      "models": [
        "sona_speech_1"
      ],
      "samples": [
        {
          "language": "ko",
          "style": "kind-default",
          "model": "sona_speech_1",
          "url": "https://example.com/samples/sample-audio.wav"
        }
      ],
      "thumbnail_image_url": "https://example.com/thumbnails/voice-thumbnail.png"
    }
  ],
  "total": 150,
  "nextPageToken": "some_opaque_token_string_representing_last_id"
}
自分のアカウントで使用可能なボイス(一般+クローンボイス含む)を名前、言語、スタイルなど様々な条件でフィルタリングできます。

主要パラメータ

パラメータ説明
nameボイス名で検索(部分一致)Coco
languageボイスの言語コード(カンマで複数入力可能)koenja
genderボイスの性別(カンマで複数入力可能)malefemale
ageボイスの年齢層child, young-adult, middle-aged, elder など
use_case主要なユースケースに基づいてフィルタリングaudiobook, narration, advertisement, など
use_cases推奨ユースケースに基づいてフィルタリングaudiobook, narration, advertisement, など
style感情スタイルフィルター (最初の値がデフォルト)neutralhappysadangryなど
description説明で検索可能(部分一致)kind and gentleなど
modelサポートする音声モデル基準フィルターsona_speech_1など
page_size1ページ当たり項目数(デフォルト:20、最大:100)50
next_page_tokenページネーション用トークン前のレスポンスで受け取ったnextPageToken
⚠️ sortパラメータはサポートしていません。

使用例1:スタイルと言語条件フィルター

GET /v1/voices/search?style=happy&language=ko,en
スタイルにhappyが含まれ、言語に韓国語(ko)と英語(en)のうち1つ以上が含まれるボイスのみが照会されます。

使用例2:ページネーション適用

GET /v1/voices/search?page_size=50&next_page_token=eyJpZCI6IjEyMzQ1In0=
  • 50個単位で次のページを取得します。
  • next_page_token値は前のレスポンスから取得できます。

注意事項

  • パラメータはすべてカンマ区切りで複数条件(OR)を入力できます。
    language=ko,en&style=happy,sad
    
  • 存在しない組み合わせを入力すると、レスポンスは200 OKですが結果が空になる可能性があります。
  • レスポンス構造はitems配列とnext_page_token値を含み、各ボイスのvoice_id、スタイル、サンプルURLなども一緒に提供されます。

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)

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.

language
string

Filter by language (comma-separated)

gender
string

Filter by gender (comma-separated)

age
string

Filter by age (comma-separated)

use_case
string

Filter by use case (comma-separated)

use_cases
string

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

style
string

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.

model
string

Filter by model (comma-separated)

Response

Paginated available voices response with next page token

items
object[]
required

List of character items

total
number
required

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

Example:

150

nextPageToken
string

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

Example:

"some_opaque_token_string_representing_last_id"