ドキュメント
Mubert AI音楽API
バージョン 3.0
Mubert AI Music API v3へようこそ!
このAPIを使用すると、アプリ、ゲーム、またはサービスにトラック生成および音楽ストリーミング機能を統合できます。APIの利用を開始するには、Mubertチーム([email protected])にAPIキーを申請してください。
REST API は SSL (HTTPS) 上で JSON のみを使用して通信します。すべてのエンドポイント URL は https://music-api.mubert.com/api/v3/ で始まります(ストリーミング URL は除く。それらは https://stream.mubert.com/b2b/v3/ で始まります)
パラメータは JSON にシリアライズし、リクエスト本文で送信する必要があります。
メディアタイプの指定として application/json を使用してください。
APIには主なディレクトリが2つあります:
サービス —
https://music-api.mubert.com/api/v3/service/— 会社がライセンスと顧客を管理するために使用されます。公開 —
https://music-api.mubert.com/api/v3/public/— 顧客がストリーミング機能とトラックを受け取るために使用されます。
認証
REST API は API キーによる認証を受け付けます。
企業向け
お客様向け
REST API は SSL (HTTPS) 上で JSON のみを使用して通信します。すべてのエンドポイント URL は https://music-api.mubert.com/api/v3/ で始まります(ストリーミング URL は除く。それらは https://stream.mubert.com/b2b/v3/ で始まります)
service ディレクトリには COMPANY_ID と LICENSE_TOKEN のペアを使用し、public ディレクトリには CUSTOMER_ID と ACCESS_TOKEN のペアを使用します。
COMPANY_ID / LICENSE_TOKEN / CUSTOMER_ID / CUSTOMER_TOKEN を実際のトークンに置き換える必要があります。
ライセンス
お客様の利便性のため、1つの会社で、それぞれ独自の機能と制限を持つ複数のライセンスを利用できるようにしています。これにより、ユーザーを異なるライセンスに分けることができます。既定では、会社には1つのライセンスがあり、ほとんどの場合、これで十分です。
ライセンスと制限に関する情報を確認できます。
モデルのライセンスをGETリクエストで使用します
特定のライセンスに関する情報も取得できます
応答
200 OK
これはライセンスモデルです。ここでは、ライセンスの機能、デフォルトパラメーター、制限、および統計情報を確認できます。
一部の制限値に-1が見られることがありますが、これは制限が設定されていないこと(無制限)を意味します。
ウェブフック
このバージョンのAPIでは、ライセンスにWebhookを追加でき、トラック生成プロセスのステータスに関する通知を受け取ることができます。
PUT メソッドを使用して webhook を設定します
更新されたライセンスモデルを受け取ります。
Webhook を追加すると、トラックモデルを含むメッセージの受信が始まります。たとえば次のようになります:
track モデルの詳細は、Track generation のセクションでご確認いただけます。
ユーザー登録
製品(サービス)の各エンドユーザーは、固有のトークンの組み合わせで識別されます: customer-id と access-token。これらのトークンは、コンテンツや機能にアクセスするために必要です。
音楽を提供したいユーザー数と同じだけのお客様を作成してください。
作成するには、以下に説明する customers モデルを POST リクエストで使用します。
入力パラメータ
custom_id — あなたの内部で一意の顧客IDで、ラテン文字、数字、および許可された特殊文字: ".", "_", "@", "-" を含めることができ、255文字を超えてはいけません。
company-id および license-token — Mubertチームによって提供されます
成功した場合は、200 OKレスポンスとJSONレスポンスを返します。
顧客モデルがあります
こちらです:
顧客ID =
data->access->customer_id(CUSTOMER_ID)アクセストークン =
data->access->access_token(ACCESS_TOKEN)daily_reset_at, monthly_reset_at — null 許容の日付
また、個別の顧客の制限と統計情報も確認できます。
ユーザー管理
ユーザー情報
ページネーションを使用して、すべてのユーザーに関する情報を取得できます。
モデル customers で GET リクエストを使用します
レスポンスには顧客モデルの一覧が含まれています。
すべてのデータを表示するには、ページネーションを使用してください。
彼のカスタムIDまたは顧客IDを使用して、特定の顧客に関する情報を取得することもできます。例えば、次のように:
または
回答には顧客モデルも含まれています。
ユーザーの削除
モデル customers で DELETE リクエストを使用してください
成功した場合は、204 No Content レスポンスを返します。
チャンネル一覧
ユーザー情報
ストリーミングとトラック生成の両方で、音楽チャンネルを選択する必要があります。
モデル playlists で GET を使用して、利用可能なすべてのカテゴリ、グループ、チャンネル、およびそれらのプレイリストインデックスの一覧を取得します。
応答 200 OK
ここではBPMの範囲とキーの一覧も確認できます。これらの値はトラック生成に利用できます。
ご注意ください。bpmパラメータには、特定のカテゴリで生成できる範囲があります。
gt は「より大きい」を意味し、lt は「より小さい」を意味します。
音楽ストリーミング
ストリーミング機能を使用する前に、契約上で有効になっていることを確認してください。また、ライセンス情報でも確認できます。ストリーミングへのリンクを取得するには、以下のリクエストを使用してください
リクエスト
レスポンス 200 OK
パラメータ
playlist_index(必須)— チャンネルのインデックスbitrate(任意)— kbpsで測定される音質intensity(任意)— 編成の複雑さ。同時に演奏される楽器が少ないか多いかtype(任意)— ストリーミングプロトコルの種類
bitrate の可能な値: 32, 96, 128, 192, 256, 320
intensity の可能な値: low, medium, high
type の可能な値: http, webrtc
オプションのパラメータが省略されているか、または値が正しくない場合は、デフォルトのパラメータが bitrate=128、intensity=high、および type=http で適用されます。
gt は「より大きい」を意味し、lt は「より小さい」を意味します。
ループモード
最新の音楽作品の最後の部分をループするには(またはループモードをオフにするには)、set-loop-state URL を使用します。
パラメータ
loop(必須)— 指定可能な値:off,ontime(オプション)— UX を改善するため、現在のストリーム再生時間(セッション開始からの秒数)と同じ値に設定します
リクエスト
応答
成功した場合は 204 No content を返します。
強度
set-intensity のURLを使うと、アレンジの複雑さを変更できます。各プリセットは、同時に演奏される楽器の数が少ないものから多いものまであります。強度は、ストリームを途切れさせることなくシームレスに変化します。
強度の可能な値: low, medium, high
リクエスト
応答
成功した場合は 204 No content を返します。
生成の再開
ストリームを再起動して、同じ url で別のトラック(メロディ)が再生され始めるようにするには、POST メソッドと streaming/restart を使用します。
リクエスト
応答
成功した場合は 204 No content を返します。
トラック生成
トラック生成機能を使い始める前に、契約内容で有効になっていることを確認してください。また、ライセンス情報でも確認できます。
このAPIを使えば、リクエストに応じてカスタムトラックを作成できます。各トラックはあなただけのオリジナル楽曲で、特別なリンクからダウンロードできます。
トラックを操作するには、モデル tracks を使用します。
トラックを作成
選択した特性のセットでトラックを作成するには、POST を使用します。
リクエスト
パラメータ
playlist_index(必須)- チャンネルインデックスduration(必須)- トラックの長さ(秒)format(任意)- mp3 または wavbitrate(任意)- kbpsで測定される音質intensity(任意)- 編成の複雑さ。同時に演奏される楽器の数が少ないか多いかmode(任意)— 構成タイプ(track,loop,jingle,mix)
bitrate の可能な値: 32, 96, 128, 192, 256, 320
intensity の可能な値: low, medium, high
オプションのパラメータが省略されるか、誤った値が含まれている場合は、format=mp3、bitrate=128、intensity=high、mode=track のデフォルトパラメータが適用されます。
track - は、イントロ、ドロップ、ブレイク、アウトロを備えた共通の構成を持つトラックを意味します
loop - は、ループ再生できるトラックを指します
jingle - は、40秒までの音楽コンテンツに最適です。これは、固定され論理的な構成を持つ短い完成トラックです
mix - はDJの作業を模倣したもので、トラックが次々と流れ、滑らかにブレンドされます
playlist_index は「0.0.0」形式の汎用チャンネルインデックスで、category_id.group_id.channel_id で構成されます。複数のチャンネルをまとめるには、後ろの桁を省略します。
例えば: playlist=0.0 は「Calm」グループ内のすべてのチャンネルを再生し、playlist=0 は「Moods」カテゴリ全体を再生します。
応答
こちら:
prompt,key,bpm,url— NULL可能な文字列generated_at,expired_at— NULL可能な日付
トラックが作成されているかを確認するには、tracks モデルを TRACK_ID とともに使用します。次のようにします:
リクエスト
または、ライセンスに webhook を追加して、完了時にメッセージを受け取ることもできます。
テキスト-2-ミュージック
テキストプロンプトと選択した特徴のセットを使って、トラックを作成できます。この方法は前の方法に似ていますが、チャンネルを選ぶ代わりに、テキストメッセージを送信します。それはタグベースを持つトランスフォーマーニューラルネットワークに送られ、対応する音のセットが自動的に選択されます。その後、私たちのコンポーザーエンジンがトラックを作成し、ファイルをあなたに返します。
ご利用を開始する前に、契約同意書で有効になっていることを確認してください。
リクエスト
パラメータ
prompt(必須)—英語で入力するテキストプロンプト、最大200文字duration(必須)—トラックの長さ(秒)format(任意)—mp3またはwavbitrate(任意)— kbps で測定される音質intensity(任意)— 編曲の複雑さ。同時に演奏される楽器の数が少ないか多いかmode(任意)— 作曲タイプ(track、loop)
bitrate の可能な値: 32, 96, 128, 192, 256, 320
intensity の可能な値: low, medium, high
prompt — ユーザー入力やその他の接続された入力(言語モデル、画像からテキストへの変換、ゲームメカニクスなど)から受け取ることができるテキストプロンプト
track — イントロ、ドロップ、ブレイク、アウトロからなる共通構成のトラックを意味します
loop — ループ可能なトラックを表します
オプションのパラメータが省略された場合、または値が正しくない場合は、format=mp3、bitrate=128、intensity=high、mode=track を使用したデフォルトのパラメータが適用されます
応答
成功した場合は 204 No content を返します。
強度
set-intensity のURLを使うと、アレンジの複雑さを変更できます。各プリセットは、同時に演奏される楽器の数が少ないものから多いものまであります。強度は、ストリームを途切れさせることなくシームレスに変化します。
強度の可能な値: low, medium, high
リクエスト
応答
成功した場合は 204 No content を返します。
生成の再開
ストリームを再起動して、同じ url で別のトラック(メロディ)が再生され始めるようにするには、POST メソッドと streaming/restart を使用します。
リクエスト
応答
成功した場合は 204 No content を返します。
画像から音楽へ
画像を使ってトラックを作成できます。使用を始める前に、契約内容に基づいて有効になっていることを確認してください。
リクエスト
パラメータ
image(必須)— JPEG/PNG 形式の画像、最大 10 MBduration(必須)— トラックの長さ(秒)format(任意)— mp3 または wavbitrate(任意)— kbps で測定される音質intensity(任意)— アレンジの複雑さ。同時に演奏される楽器の数が少ないか多いかmode(任意)— 作曲タイプ(track、loop)
bitrate の可能な値: 32, 96, 128, 192, 256, 320
intensity の可能な値: low, medium, high
track — イントロ、ドロップ、ブレイク、アウトロを含む一般的な構成のトラックを意味します
loop — ループ再生できるトラックを表します
オプションのパラメータが省略されたり、誤った値が含まれている場合は、format=mp3、bitrate=128、intensity=high、mode=track のデフォルトパラメータが適用されます
BPM/キー生成
playlist_index の生成パラメータに bpm と key を追加できます。
リクエスト
応答
成功すると track モデルで 200 OK を返します。
類似を生成
既存のトラックに似たトラックを生成できます。まったく同じものではありませんが、似ています。
POST で https://music-api.mubert.com/api/v3/public/tracks/TRACK_ID/similar を使用してください
リクエスト
トラック編集
既存のトラックの一部のパラメーターを変更できます。
リクエスト
応答 200 OK
また、トラックの一部を置き換えることもできます。各トラックは楽器で構成されています。トラックには次のような楽器が含まれる場合があります:
ドラムス, パーカッション, ハット, クラップ, ベース, ミッド, リード, エフェクト, ボーカル, パッド, ライザー, インパクト
これらの楽器は、次のようなステムに組み合わせることができます
つまり、これらのステムには次の楽器が含まれています:
DRUMSにはDRUMS、PERCS、HATS、CLAPSが含まれますBASSにはBASSが含まれますLEADSにはMIDS、LEADS、PADSが含まれますVOCALSにはVOCALSが含まれますFXにはFX、RISER、IMPACTが含まれます
器具とステムの両方を交換できます。器具を交換するには:
楽器を置き換える:
ステムを交換:
楽器を削除:
茎を削除:
これらのリクエストはすべてtrackモデルを受け取ります。
トラック一覧
トラック一覧を取得するには、GET を tracks モデルで使用してください。
レスポンスにはトラックモデルの一覧が含まれています。
ページネーションを使用して、すべてのデータを表示してください。
特定のトラックに関する情報も確認できます。
応答にはトラックモデルが含まれています。
トラックストア
トラック保存機能を使うと、事前生成されたトラックを格納するバッファを作成できます。長い待ち時間なしで、指定した長さ、モード、形式のユニークなトラックを取得したい場合に最適です。私たちはクラウドバケットを作成し、ファイルの受信を高速化するための専用ジェネレーターをセットアップします。Mubert は、1組のパラメータで複数のトラックを生成してバケットに保存します。これらのファイルのいずれかを使用すると、バッファを補充するための類似したトラック生成が開始されます。バケット内のファイル数は、サービスの平均負荷によって決まります。これを計算するために、次のパラメータ一覧も必要です: モード、長さ、ビットレート、強度、形式。バケット作成を続けるには、これらのパラメータの値を選択し、担当マネージャーにメールを送信してください。また、事前生成したいプレイリストを選択することもできます。デフォルトではすべてのチャンネルを使用します。
track のリクエストパラメータが store のパラメータと一致すると、track store から track を自動的に取得できます。track store の利用を開始する前に、契約内容で有効になっていることを確認してください。
Mubert 音楽ライブラリ
当社の音楽エディターが厳選した、Mubertの人工知能を使って制作された12,000曲以上のトラックからなるライブラリをご用意しました。
パラメータ
音楽ライブラリの統計情報と、トラックを絞り込むために使用できるパラメータを確認するには、GET メソッドを使用します。
リクエスト
応答
特定のパラメータに関する情報も取得できます。たとえば: BPM 120
応答
これは、テーマ「Сorporate」で BPM 120 のトラックが 315 曲、テーマ「Podcast」で 12 曲、ジャンル「Nu Disco」で 138 曲、ジャンル「Folk」で 27 曲見つけられることを意味します。
複数のパラメータを指定すると、それらに論理 AND が適用されます。
リクエスト
応答
応答では、リクエスト BPM 120 AND Genre Nu Disco に対応する各再生時間ごとのトラック数も確認できます
トラック
GETメソッドを使用してトラックの一覧を受信します。
リクエスト
応答
レスポンスにはトラックモデルの一覧が含まれています。すべてのデータを見るにはページネーションを使用してください。また、1つ以上のパラメータを使用してトラックを絞り込み、最適なものを見つけることもできます。例えば: BPM 120 AND Genre Nu Disco AND Duraton 180
リクエスト
応答
レスポンスにはトラックモデルの一覧も含まれます。すべてのデータを表示するにはページネーションを使用してください。
スワッガー
より技術的な情報については、swagger を使用できます: https://music-api.mubert.com/api/v3/swagger
価格
月額49ドルから試してみてください
現在 配信中 — 動画にサウンドトラックを付けよう