音楽を作曲

プロンプトまたは構成プランから曲を作成します。

ヘッダー

xi-api-keystringオプション

クエリパラメータ

output_formatenumオプションデフォルト値 auto
生成されたオーディオの出力形式。codec_sample_rate_bitrate形式で指定します。選択したモデルに最適な形式をAPIに選択させるには、"auto"(デフォルト)を使用します。v1モデルではmp3_44100_128、v2モデルではmp3_48000_192が選択されます。

リクエスト

This endpoint expects an object.
promptstring or nullオプション<=4100 characters

楽曲を生成するためのシンプルなテキストプロンプトです。composition_planと併用できません。

composition_planobject or nullオプション

音楽生成をガイドする詳細な構成プランです。promptと同時には使用できません。

music_length_msinteger or nullオプション3000-600000

生成する曲の長さ(ミリ秒)。promptと併用する場合にのみ使用します。3000msから600000msの範囲で指定します。任意です。指定しない場合、モデルがプロンプトに基づいて長さを選択します。

model_idenumオプションデフォルト値 music_v1

生成に使用するモデル。

許可された値:
seedinteger or nullオプション0-2147483647

音楽生成プロセスを初期化するランダムシード。同じパラメータで同じシードを指定すると、より一貫した結果を得やすくなりますが、完全な再現性は保証されず、システムの更新によって出力が変わる場合があります。promptと併用できません。

force_instrumentalbooleanオプションデフォルト値 false

trueの場合、生成される楽曲がインストゥルメンタルであることを保証します。falseの場合、楽曲がインストゥルメンタルになるかどうかはpromptによって異なります。promptと組み合わせてのみ使用できます。

finetune_idstring or nullオプション<=100 characters

生成に使用するFinetuneのID

respect_sections_durationsbooleanオプションデフォルト値 true

composition_plan内のセクションの長さをどの程度厳密に適用するかを制御します。composition_planでのみ使用され、music_v1にのみ適用されます。music_v2およびmusic_v2_5ではセクションの長さが常に適用されるため、この設定は無視されます。music_v1でfalseの場合、プランの合計楽曲時間を維持しつつ、品質とレイテンシーを改善するためにモデルが各セクションの長さを調整することがあります。

store_for_inpaintingbooleanオプションデフォルト値 false

インペインティング用に生成した楽曲を保存するかどうか。

sign_with_c2pabooleanオプションデフォルト値 false

生成した楽曲にC2PA署名を付与するかどうか。mp3ファイルにのみ適用されます。

レスポンスヘッダー

song-idstringオプション

生成された曲の一意の識別子

レスポンス

指定形式の生成済みオーディオファイル

エラー

422
Unprocessable Entity Error