主要パラメータ
パラメータ | 説明 | 例 |
---|---|---|
name | ボイス名で検索(部分一致) | Coco |
language | ボイスの言語コード(カンマで複数入力可能) | ko 、en 、ja |
gender | ボイスの性別(カンマで複数入力可能) | male 、female |
age | ボイスの年齢層 | child , young-adult , middle-aged , elder など |
use_case | 主要なユースケースに基づいてフィルタリング | audiobook , narration , advertisement , など |
use_cases | 推奨ユースケースに基づいてフィルタリング | audiobook , narration , advertisement , など |
style | 感情スタイルフィルター (最初の値がデフォルト) | neutral 、happy 、sad 、angry など |
description | 説明で検索可能(部分一致) | kind and gentle など |
model | サポートする音声モデル基準フィルター | sona_speech_1 など |
page_size | 1ページ当たり項目数(デフォルト:20、最大:100) | 50 |
next_page_token | ページネーション用トークン | 前のレスポンスで受け取ったnextPageToken 値 |
⚠️ sort
パラメータはサポートしていません。
使用例1:スタイルと言語条件フィルター
使用例2:ページネーション適用
- 50個単位で次のページを取得します。
next_page_token
値は前のレスポンスから取得できます。
注意事項
- パラメータはすべてカンマ区切りで複数条件(OR)を入力できます。
- 存在しない組み合わせを入力すると、レスポンスは200 OKですが結果が空になる可能性があります。
- レスポンス構造は
items
配列とnext_page_token
値を含み、各ボイスのvoice_id
、スタイル、サンプルURLなども一緒に提供されます。
Headers
API key for the service
Query Parameters
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)
Response
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"