モデル

音声モデルを一覧表示

モデルごとの声の系列、文字数上限、出力形式と料金を確認してから生成します。 料金と利用量の例は形式を示す値です。実際の値は取得したカタログで確認してください。

GET
/v1/creative/tts-router/models
curl --request GET 'https://api.orchestor.io/v1/creative/tts-router/models' \  --header "Authorization: Bearer $ORCHESTOR_API_KEY"
{  "data": {    "models": [      {        "id": "sonic-3.6",        "name": "sonic-3.6",        "modality": "audio",        "routing": "pass_through",        "constraints": [],        "voice_family": "sonic",        "capabilities": {          "text_to_speech": true,          "max_characters": 20000        },        "pricing": {          "basis": "per_character",          "credits_per_1000_characters": 0        }      }    ]  }}

認証

次のいずれかの条件を満たしてください。

  • bearerAuth
  • x-api-key

認証の詳細

bearer
Authorization

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

レスポンス

application/json

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

ヘッダー

x-orchestor-request-idstringheader

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

ratelimit-limitintegerheader

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

ratelimit-remainingintegerheader

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

ratelimit-resetintegerheader

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

retry-afterintegerheader

再試行までの待機秒数。

x-orchestor-poll-afterintegerheader

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

値の範囲
≥ 0
{  "data": {    "models": [      {        "id": "sonic-3.6",        "name": "sonic-3.6",        "modality": "audio",        "routing": "pass_through",        "constraints": [],        "voice_family": "sonic",        "capabilities": {          "text_to_speech": true,          "max_characters": 20000        },        "pricing": {          "basis": "per_character",          "credits_per_1000_characters": 0        }      }    ]  }}
dataobject必須

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

追加プロパティ
許可しない
data.modelsTtsRouterCatalogItem[]必須

このルーターで選択できるモデルと、それぞれの対応入力・料金・制約。

data.models[]TtsRouterCatalogItem
追加プロパティ
許可しない
data.models[].idstringenum<string>必須

生成要求の model に渡すカタログ ID。別名ではなく、この値をそのまま指定します。

許可される値
sonic-3.6sonic-3.5sonic-3sonic-latestsonic-previewsonic-2sonic-turboeleven-v4eleven-v4-turboeleven-v3eleven-multilingual-v2eleven-turbo-v2.5seed-audio-1.0qwen-audio-3.0-ttsminimax-speech-2.8-hdseed-speech
data.models[].namestring必須

モデル選択画面に表示する名称。要求には名称ではなく id を指定します。

data.models[].voice_familystringenum<string>

このモデルと組み合わせる声の一覧を選ぶ family の値。別の系列の声は使用できません。

許可される値
sonicelevenseed_audioqwenminimaxseed_speech
data.models[].modalitystringenum<string>必須

生成されるメディアの種類。音声・音楽モデルは audio を返します。

許可される値
audio
data.models[].routingstringenum<string>必須

指定したモデルへ直接送るか、カタログの選択規則で別のモデルへ解決するかを示します。

許可される値
pass_through
data.models[].capabilitiesobject必須

利用可能な入力や設定の範囲。記載のない設定を要求に追加しないでください。

追加プロパティ
許可しない
data.models[].capabilities.text_to_speechboolean必須

文章を音声に変換する入力に対応しているかを示します。

data.models[].capabilities.max_charactersinteger必須

一度の音声生成で入力できる文章の文字数上限。

data.models[].capabilities.languagesstring[]

音声生成で受け付ける言語の ISO 639-1 コード。

data.models[].capabilities.languages[]string
data.models[].capabilities.output_formatsstring[]

音声のコンテナ、サンプルレート、ビットレートを組み合わせた出力形式。

data.models[].capabilities.output_formats[]string
data.models[].capabilities.settingsobject

指定可能な声の設定ごとの min、max、step、default。項目がなければ指定できません。

data.models[].pricingobject必須

生成量に適用する課金単位と単価。要求全体の金額は入力の長さなどに応じて計算します。

追加プロパティ
許可しない
data.models[].pricing.basisstringenum<string>必須

単価を適用する生成量の単位。文字数、音声一つ、秒数、分数を区別します。

許可される値
per_character
data.models[].pricing.credits_per_1000_charactersnumber | null必須

入力文章 1,000 文字あたりに消費するクレジット。換算価格が未設定の場合は null。

値の範囲
≥ 0
data.models[].constraintsstring[]必須

文字数、長さ、入力の組み合わせなど、要求が満たす必要のある条件。

data.models[].constraints[]string