音声を一覧表示

検索、フィルタリング、ページネーションを使用して、ユーザーが利用可能なすべての音声のリストを取得します。

ヘッダー

xi-api-keystringオプション

クエリパラメータ

next_page_tokenstring or nullオプション

ページネーションに使用する次のページトークン。前のリクエストから返されます。確実にページネーションするには、has_moreフラグと組み合わせて使用してください。

page_sizeintegerオプションデフォルト値 10

返す音声の最大数です。100を超えることはできず、デフォルトは10です。デフォルト音声が含まれるため、ページ0にはより多くの音声が含まれる場合があります。

searchstring or nullオプション

音声を絞り込む検索語です。名前、説明、ラベル、カテゴリを検索します。

sortstring or nullオプション

並べ替えに使用するフィールド。‘created_at_unix’または’name’のいずれか。古い音声では’created_at_unix’を利用できない場合があります。

sort_directionstring or nullオプション

音声を並べ替える順序。‘asc’または’desc’。

voice_typestring or nullオプション
フィルタリングする音声のタイプ。'personal'、'community'、'default'、'workspace'、'non-default'、'non-community'、'saved'のいずれかです。'non-default'は'default'以外のすべてと同じです。'non-community'は'personal'と'workspace'を組み合わせたものです(ライブラリのコピーを除く)。'saved'はnon-defaultと同じですが、コレクションに追加されている場合はデフォルト音声も含まれます。
categorystring or nullオプション

フィルタリングする音声のカテゴリです。‘premade’、‘cloned’、‘generated’、‘professional’のいずれかです。

fine_tuning_statestring or nullオプション

フィルタリング対象の音声の微調整状態です。プロフェッショナルボイスクローンにのみ適用されます。‘draft’、‘not_verified’、‘not_started’、‘queued’、‘fine_tuning’、‘fine_tuned’、‘failed’、‘delayed’のいずれかです。

collection_idstring or nullオプション

音声のフィルタリングに使用するコレクションID。

genderstring or nullオプション

音声の’gender’ラベルに基づき、フィルタリングに使用する性別。

agestring or nullオプション

音声の「age」ラベルに基づき、フィルタリングに使用する年齢。

languagelist of strings or nullオプション

音声の「language」ラベルに基づくフィルタリングに使用する言語。指定したいずれかの言語に一致する音声が返されます。

accentstring or nullオプション

音声の「accent」ラベルに基づき、フィルタリングに使用するアクセント。

use_caseslist of strings or nullオプション

音声の「use_case」ラベルに基づいてフィルタリングに使用するユースケース。指定したユースケースのいずれかに一致する音声が返されます。

min_notice_period_daysinteger or nullオプション

共有の事前通知期間が指定した日数以上の音声にフィルタリングします。

include_custom_ratesboolean or nullオプション

カスタム共有率が設定された音声を含めるかどうか。デフォルトでは含められます。

include_live_moderatedboolean or nullオプション

ライブモデレーションが有効な音声を含めるかどうか。デフォルトでは含められます。

high_qualityboolean or nullオプション

trueの場合、スタジオ品質の音声(categoryが’high_quality’のもの)のみを返します。

include_total_countbooleanオプションデフォルト値 true
レスポンスに見つかった音声の合計数を含めるかどうか。注:total_countの値はライブスナップショットであり、ユーザーが音声を作成、変更、削除することでリクエスト間に変わる可能性があります。ページネーションには、代わりにhas_moreフラグを使用してください。パフォーマンスコストがかかるため、合計数が実際に必要な場合(例:表示目的)にのみ有効にしてください。
voice_idslist of strings or nullオプション

検索対象の音声ID。最大100件の音声IDを指定できます。

レスポンス

成功レスポンス。

voiceslist of objects

クエリに一致する音声のリスト。

has_moreboolean

後続のページに利用可能な音声がさらにあるかどうかを示します。total_countに依存せず、信頼性の高いページネーションを行うにはこのフラグとnext_page_tokenを使用してください。

total_countinteger

クエリに一致する音声の合計数です。この値はデータベースの現在の状態を反映するライブスナップショットであり、ユーザーが音声を作成、変更、削除するとリクエスト間で変わる可能性があります。信頼性の高いページネーションには、この値に依存せずhas_moreフラグを使用してください。合計数の算出にはパフォーマンスコストがかかるため、実際に必要な場合(表示目的など)にのみこのフィールドをリクエストしてください。

next_page_tokenstring or nullオプション

結果の次ページを取得するためのトークン。ページネーションを続けるには、この値を次のリクエストに渡します。結果がこれ以上ない場合はnullです。

エラー

422
Unprocessable Entity Error