モデル

音楽モデルを取得

一つのモデルが受け付ける入力と長さを確認します。自動選択行では resolves_to も確認します。 料金と利用量の例は形式を示す値です。実際の値は取得したカタログで確認してください。

GET
/v1/creative/music-router/models/{model_id}
curl --request GET 'https://api.orchestor.io/v1/creative/music-router/models/lyria-3-pro' \  --header "Authorization: Bearer $ORCHESTOR_API_KEY"
{  "data": {    "model": {      "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"      }    }  }}

認証

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

  • bearerAuth
  • x-api-key

認証の詳細

bearer
Authorization

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

パスパラメータ

model_idstringpath必須

取得対象のモデル ID。表示名ではなくカタログの値を指定します。

レスポンス

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": {    "model": {      "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"      }    }  }}
dataobject必須

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

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

生成で使用するカタログ ID。対応する入力・設定をモデル一覧で確認してください。

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

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

許可される値
orchestor/music-autolyria-3-pro
data.model.namestring必須

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

data.model.modalitystringenum<string>必須

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

許可される値
audio
data.model.routingstringenum<string>必須

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

許可される値
autopass_through
data.model.resolves_tostringenum<string>

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

許可される値
orchestor/music-autolyria-3-pro
data.model.capabilitiesobject必須

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

追加プロパティ
許可しない
data.model.capabilities.text_to_musicboolean必須

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

data.model.capabilities.image_conditioningboolean必須

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

data.model.capabilities.lyricsboolean必須

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

data.model.capabilities.max_prompt_charactersinteger必須

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

data.model.capabilities.duration_secondsobject

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

追加プロパティ
許可しない
data.model.capabilities.duration_seconds.mininteger必須

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

data.model.capabilities.duration_seconds.maxinteger必須

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

data.model.capabilities.duration_seconds.defaultinteger必須

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

data.model.pricingobject必須

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

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

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

許可される値
per_audioper_secondper_minute
data.model.pricing.credits_per_audiointeger必須

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

値の範囲
≥ 0
data.model.pricing.usd_per_audiostring必須

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

パターン
^\d+\.\d{4,}$
data.model.pricing.credits_per_minuteinteger

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

値の範囲
≥ 0
data.model.pricing.usd_per_minutestring

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

パターン
^\d+\.\d{4,}$
data.model.constraintsstring[]必須

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

data.model.constraints[]string