Creative Models

音楽モデルを一覧表示

入力画像や秒数指定への対応、料金と制約を比較して曲を生成するモデルを選びます。 料金と利用量の例は形式を示す値です。実際の値は取得したカタログで確認してください。

GET
/v1/creative/music-router/models
curl --request GET 'https://api.orchestor.io/v1/creative/music-router/models' \  --header "Authorization: Bearer $ORCHESTOR_API_KEY"
{  "data": {    "models": [      {        "id": "lyria-3-pro",        "name": "lyria-3-pro",        "modality": "audio",        "routing": "pass_through",        "constraints": [],        "capabilities": {          "text_to_music": true,          "image_conditioning": true,          "lyrics": false,          "max_prompt_characters": 5000        },        "pricing": {          "basis": "per_audio",          "credits_per_audio": 0,          "usd_per_audio": "0.0000"        }      }    ]  }}

Authorizations

Satisfy one of these options:

  • bearerAuth
  • x-api-key

Authentication details

bearer
Authorization

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

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": {    "models": [      {        "id": "lyria-3-pro",        "name": "lyria-3-pro",        "modality": "audio",        "routing": "pass_through",        "constraints": [],        "capabilities": {          "text_to_music": true,          "image_conditioning": true,          "lyrics": false,          "max_prompt_characters": 5000        },        "pricing": {          "basis": "per_audio",          "credits_per_audio": 0,          "usd_per_audio": "0.0000"        }      }    ]  }}
dataobjectrequired

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

Additional properties
Not allowed
data.modelsMusicRouterCatalogItem[]required

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

data.models[]MusicRouterCatalogItem
Additional properties
Not allowed
data.models[].idstringenum<string>required

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

Allowed
orchestor/music-autolyria-3-pro
data.models[].namestringrequired

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

data.models[].modalitystringenum<string>required

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

Allowed
audio
data.models[].routingstringenum<string>required

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

Allowed
autopass_through
data.models[].resolves_tostringenum<string>

自動選択の行が現在解決するモデル ID。実行前にカタログで確認します。

Allowed
orchestor/music-autolyria-3-pro
data.models[].capabilitiesobjectrequired

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

Additional properties
Not allowed
data.models[].capabilities.text_to_musicbooleanrequired

文章の指示から楽曲を生成する入力に対応しているかを示します。

data.models[].capabilities.image_conditioningbooleanrequired

画像を楽曲生成の参照入力として使用できるかを示します。

data.models[].capabilities.lyricsbooleanrequired

歌詞を指定した生成に対応しているかを示します。

data.models[].capabilities.max_prompt_charactersintegerrequired

楽曲の指示として送れる文章の文字数上限。

data.models[].capabilities.duration_secondsobject

指定可能な音声の秒数。項目がない場合はモデルが長さを決めます。

Additional properties
Not allowed
data.models[].capabilities.duration_seconds.minintegerrequired

指定できる長さの下限。単位は秒です。

data.models[].capabilities.duration_seconds.maxintegerrequired

指定できる長さの上限。単位は秒です。

data.models[].capabilities.duration_seconds.defaultintegerrequired

長さを省略したときに適用する秒数。

data.models[].pricingobjectrequired

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

Additional properties
Not allowed
data.models[].pricing.basisstringenum<string>required

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

Allowed
per_audioper_secondper_minute
data.models[].pricing.credits_per_audiointegerrequired

一回の音声生成で消費するクレジット。長さによる課金では既定の長さに対する値。

Value range
≥ 0
data.models[].pricing.usd_per_audiostringrequired

一回の音声生成の USD 金額。長さによる課金では既定の長さに対する値。

Pattern
^\d+\.\d{4,}$
data.models[].pricing.credits_per_minuteinteger

生成音声 1 分あたりに消費するクレジット。

Value range
≥ 0
data.models[].pricing.usd_per_minutestring

生成音声 1 分あたりの USD 単価。

Pattern
^\d+\.\d{4,}$
data.models[].constraintsstring[]required

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

data.models[].constraints[]string