Creative Models

声の候補を一覧表示

モデルの voice_family を family に指定し、返された声の id を生成要求の voice.id に使います。対応する声がない系列では空の一覧を返します。

GET
/v1/creative/tts-router/voices
curl --request GET 'https://api.orchestor.io/v1/creative/tts-router/voices?family=eleven' \  --header "Authorization: Bearer $ORCHESTOR_API_KEY"
{  "data": {    "family": "sonic",    "source": "preset",    "voices": []  }}

Authorizations

Satisfy one of these options:

  • bearerAuth
  • x-api-key

Authentication details

bearer
Authorization

外部 API キー。session は受け付けません。apiKey と同時に送ると 401 です。

Query Parameters

familystringenum<string>queryrequired

モデルと声を組み合わせる系列。別系列の ID を混在させないでください。

Allowed
sonicelevenseed_audioqwenminimaxseed_speech
purposestringenum<string>query

voice_change と family=eleven を指定すると、アカウントで利用できる ElevenLabs の既定ボイスを返します。

Allowed
voice_change

Response

application/json

指定した対象の取得結果。次の要求には返された ID と制約を使用します。

Headers

x-orchestor-request-idstringheader

HTTP リクエストの相関 ID。ジョブの request_id とは別の値。

ratelimit-limitintegerheader

現在の期間で許可されるリクエスト数。

ratelimit-remainingintegerheader

現在の期間で残っているリクエスト数。

ratelimit-resetintegerheader

制限がリセットされるまでの秒数。

retry-afterintegerheader

再試行までの待機秒数。

x-orchestor-poll-afterintegerheader

次のジョブ状態取得までの待機秒数。

Value range
≥ 0
{  "data": {    "family": "sonic",    "source": "preset",    "voices": []  }}
dataobjectrequired

呼び出し結果を格納するオブジェクト。エラー時は error を確認してください。

Additional properties
Not allowed
data.familystringenum<string>required

モデルと声を組み合わせる系列。別系列の ID を混在させないでください。

Allowed
sonicelevenseed_audioqwenminimaxseed_speech
data.sourcestringenum<string>required

声一覧の取得元。live はライブラリ、premade は既定の声、preset は固定プリセットです。

Allowed
livepremadepreset
data.voicesTtsRouterVoice[]required

指定した family の声の候補。生成時にはこの中の id を使います。

data.voices[]TtsRouterVoice
Additional properties
Not allowed
data.voices[].sourcestringenum<string>

custom は現在のワークスペースが作成したボイスです。省略時はプリセットです。

Allowed
presetcustom
data.voices[].idstringrequired

生成要求の voice.id に指定する声の ID。表示名ではなく一覧の値をそのまま使います。

data.voices[].familystringenum<string>required

モデルと声を組み合わせる系列。別系列の ID を混在させないでください。

Allowed
sonicelevenseed_audioqwenminimaxseed_speech
data.voices[].namestringrequired

声を選ぶときに表示する名前。要求には id を指定します。

data.voices[].descriptionstring | nullrequired

声の特徴を説明する文章。情報がない場合は null です。

data.voices[].languagestring | nullrequired

読み上げる言語の BCP-47 または ISO 639 コード。日本語なら ja を明示します。

data.voices[].genderstring | nullenum<string | null>required

声の性別表現。分類されていない場合は null です。

Allowed
malefemaleneutralnull
data.voices[].accentstring | nullrequired

声のアクセント。情報がない場合は null です。

data.voices[].countrystring | nullrequired

声に関連付けられた国の2文字コード。情報がない場合は null です。

Pattern
^[A-Z]{2}$
data.voices[].preview_urlstring | nullrequired

声を試聴する音声 URL。用意されていない場合は null です。

data.voices[].tagsstring[]required

声の特徴で候補を絞るための分類。プリセットでは category、notice、studio_quality、user_count、language などを key:value 形式で返します。

data.voices[].tags[]string
data.voices[].supported_modelsstring[]required

この声を使える音声モデルの ID 一覧。

data.voices[].supported_models[]string