Dokumentation
Mubert KI-Musik-API
Version 3.0
Inhaltsverzeichnis
Willkommen bei der Mubert AI Music API v3!
Diese API ermöglicht die Integration von Funktionen zur Track-Generierung und zum Musik-Streaming in Apps, Spielen oder Diensten. Um die API zu verwenden, fordern Sie bitte Ihre API-Schlüssel beim Mubert-Team an (via [email protected]).
Die REST-API kommuniziert ausschließlich in JSON über SSL (HTTPS). Alle Endpunkt-URLs beginnen mit https://music-api.mubert.com/api/v3/ (außer Streaming-URLs, sie beginnen mit https://stream.mubert.com/b2b/v3/)
Parameter müssen in JSON serialisiert und im Anforderungskörper übergeben werden.
Sie sollten die Medientyp-Angabe von application/json verwenden.
Es gibt zwei Hauptverzeichnisse in der API:
Dienst —
https://music-api.mubert.com/api/v3/service/— wird vom Unternehmen verwendet, um Lizenzen und Kunden zu verwalten.öffentlich —
https://music-api.mubert.com/api/v3/public/— wird von Kunden verwendet, um Streaming-Funktionen und Titel zu erhalten.
Authentifizierung
Die REST-API unterstützt eine auf API-Schlüsseln basierende Authentifizierung.
Für Unternehmen
Für Kunden
Die REST-API kommuniziert ausschließlich in JSON über SSL (HTTPS). Alle Endpunkt-URLs beginnen mit https://music-api.mubert.com/api/v3/ (außer Streaming-URLs, sie beginnen mit https://stream.mubert.com/b2b/v3/)
Für das Service-Verzeichnis verwenden Sie ein Paar aus COMPANY_ID und LICENSE_TOKEN und für das öffentliche Verzeichnis ein Paar aus CUSTOMER_ID und ACCESS_TOKEN.
Sie müssen COMPANY_ID / LICENSE_TOKEN / CUSTOMER_ID / CUSTOMER_TOKEN mit Ihren tatsächlichen Tokens ersetzen.
Lizenz
Zu Ihrer Bequemlichkeit haben wir es so eingerichtet, dass ein Unternehmen mehrere Lizenzen mit jeweils eigenen Funktionen und Limits haben kann. So können Sie Benutzer verschiedenen Lizenzen zuordnen. Standardmäßig hat das Unternehmen eine Lizenz, und in den meisten Fällen reicht das aus.
Sie können Informationen zu Ihren Lizenzen und Limits erhalten.
Verwenden Sie Modell-Lizenzen mit der GET-Anfrage
Sie können auch Informationen zu einer bestimmten Lizenz erhalten
Antwort
200 OK
Dies ist das Lizenzmodell. Hier finden Sie Lizenzfunktionen, Standardparameter, Limits und Statistiken.
Sie können -1 in einigen Grenzwerten bemerken; das bedeutet, dass ein Limit nicht gesetzt ist (unbegrenzt).
Webhooks
In dieser Version der API können Sie der Lizenz einen Webhook hinzufügen, über den Sie Benachrichtigungen über den Status des Track-Generierungsprozesses erhalten.
Verwenden Sie die PUT-Methode, um einen Webhook festzulegen
Sie erhalten das aktualisierte Lizenzmodell.
Nachdem Sie den Webhook hinzugefügt haben, erhalten Sie Nachrichten mit Track-Modellen. Zum Beispiel so:
Mehr über das Track-Modell erfahren Sie im Abschnitt Spurenerzeugung.
Benutzerregistrierung
Jeder Endbenutzer Ihres Produkts (Dienstes) wird durch ein eindeutiges Token-Paar identifiziert: customer-id und access-token. Diese Tokens sind erforderlich, um auf die Inhalte und Funktionen zuzugreifen.
Gewinnen Sie so viele Kunden, wie es Nutzer gibt, die mit Musik versorgt werden sollen.
Um es zu erstellen, verwenden Sie das Modell customers mit dem unten beschriebenen POST-Request.
Eingabeparameter
custom_id — Ihre interne eindeutige Kunden-ID, die aus lateinischen Buchstaben, Zahlen und zulässigen Sonderzeichen bestehen kann: ".", "_", "@", "-"' und nicht länger als 255 Zeichen sein sollte.
company-id and license-token — vom Mubert-Team bereitgestellt
Antwortet bei Erfolg mit einer 200-OK-Antwort und einer JSON-Antwort.
Es gibt Kundenmodell
Hier:
Kunden-ID =
data->access->customer_id(CUSTOMER_ID)Zugriffstoken =
data->access->access_token(ACCESS_TOKEN)daily_reset_at, monthly_reset_at — nullfähiges Datum
Außerdem können Sie persönliche Kundenlimits und Statistiken einsehen.
Benutzerverwaltung
Benutzerinformationen
Sie können mit Paginierung Informationen zu all Ihren Benutzern abrufen.
Verwende die GET-Anfrage mit dem Modell customers
Die Antwort enthält eine Liste von Kundenmodellen.
Verwenden Sie die Seitennummerierung, um alle Daten zu sehen.
Sie können auch Informationen über einen bestimmten Kunden mithilfe seiner benutzerdefinierten Kennung oder Kunden-ID abrufen. Zum Beispiel:
Oder
Die Antworten enthalten auch das Kundenmodell.
Benutzer löschen
Verwenden Sie die DELETE-Anfrage mit dem Modell customers
Antwortet bei Erfolg mit einer 204 No Content-Antwort.
Liste der Kanäle
Benutzerinformationen
Sowohl das Streaming als auch die Titelgenerierung erfordern, dass Sie einen Musikkanal auswählen.
Verwenden Sie GET im Modell playlists, um eine Liste aller verfügbaren Kategorien, Gruppen, Kanäle und ihrer Playlist-Indizes zu erhalten.
Antwort 200 OK
Hier können Sie auch den BPM-Bereich und die Tonartenliste sehen. Diese Werte stehen für die Track-Erstellung zur Verfügung.
Bitte beachten Sie, dass der bpm-Parameter einen verfügbaren Bereich hat, innerhalb dessen Sie in einer bestimmten Kategorie generieren können.
gt bedeutet größer als, lt bedeutet kleiner als.
Musikstreaming
Bevor Sie die Streaming-Funktion verwenden, stellen Sie sicher, dass sie im Rahmen der Vertragsvereinbarung aktiviert ist. Außerdem finden Sie sie in Ihren Lizenzinformationen. Um einen Link zum Streaming zu erhalten, verwenden Sie die folgende Anfrage
Anfrage
Antwort 200 OK
Parameter
playlist_index(erforderlich) — Kanalindexbitrate(optional) — Tonqualität gemessen in kbpsintensity(optional) — die Komplexität des Arrangements, es spielen gleichzeitig weniger oder mehr Instrumentetype(optional) — Streaming-Protokolltyp
Mögliche Werte für bitrate : 32, 96, 128, 192, 256, 320
Mögliche Werte für intensity : low, medium, high
Mögliche Werte für type : http, webrtc
Wenn optionale Parameter weggelassen werden oder falsche Werte enthalten, werden Standardparameter mit bitrate=128, intensity=high und type=http angewendet.
gt bedeutet größer als, lt bedeutet kleiner als.
Wiederholungsmodus
Verwenden Sie die set-loop-state-URL, um den letzten Teil der Musikkomposition zu wiederholen (oder den Loop-Modus auszuschalten).
Parameter
loop(verpflichtend) — mögliche Werte:off,ontime(optional) — auf die aktuelle Wiedergabezeit des Streams in Sekunden (seit Sitzungsbeginn) setzen, um die Benutzererfahrung zu verbessern
Anfrage
Antwort
Antwortet mit 204 Kein Inhalt, wenn erfolgreich.
Intensität
Die set-intensity-URL ermöglicht das Ändern der Komplexität des Arrangements. Verschiedene Presets bestehen aus weniger oder mehr Instrumenten, die gleichzeitig spielen. Die Intensitäten wechseln nahtlos, ohne den Stream zu unterbrechen.
Mögliche Werte für Intensität : low, medium, high
Anfrage
Antwort
Antwortet mit 204 Kein Inhalt, wenn erfolgreich.
Generation neu starten
Um den Stream neu zu starten, sodass ein anderer Titel (Melodie) mit derselben url abgespielt wird, verwenden Sie die POST-Methode mit streaming/restart.
Anfrage
Antwort
Antwortet mit 204 Kein Inhalt, wenn erfolgreich.
Track-Generierung
Bevor Sie die Track-Erstellungsfunktion verwenden, stellen Sie sicher, dass sie unter der Vertragsvereinbarung aktiviert ist. Außerdem finden Sie sie in Ihren Lizenzinformationen.
Mit dieser API können Sie auf Anfrage benutzerdefinierte Tracks erstellen. Jeder Track ist eine exklusive Musikkomposition, die Ihnen über einen speziellen Link zum Download zur Verfügung steht.
Um mit Tracks zu interagieren, verwenden Sie das Modell tracks.
Track erstellen
Verwenden Sie POST, um einen Track mit den ausgewählten Eigenschaften zu erstellen.
Anfrage
Parameter
playlist_index(obligatorisch) - Kanalindexduration(obligatorisch) - Titellänge in Sekundenformat(optional) - mp3 oder wavbitrate(optional) - Klangqualität gemessen in kbpsintensity(optional) - Komplexität des Arrangements, es spielen gleichzeitig weniger oder mehr Instrumentemode(optional) — Kompositionstyp (track,loop,jingle,mix)
Mögliche Werte für bitrate : 32, 96, 128, 192, 256, 320
Mögliche Werte für intensity : low, medium, high
Wenn optionale Parameter weggelassen werden oder falsche Werte enthalten, werden Standardparameter mit format=mp3, bitrate=128, intensity=high, mode=track angewendet
track - bezeichnet einen Titel mit gemeinsamer Struktur aus Intro, Drops, Breaks und Outro
loop - steht für einen Titel, der in einer Schleife wiedergegeben werden kann
jingle - eignet sich am besten für Musikinhalte mit einer Länge von bis zu 40 Sekunden – das sind kurze, abgeschlossene Titel mit fester und logischer Struktur
mix - ahmt die Arbeit eines DJs nach: Titel folgen nacheinander und gehen harmonisch ineinander über
playlist_index ist ein universeller Kanalindex im Format „0.0.0“, der aus category_id.group_id.channel_id besteht. Lassen Sie die letzten Ziffern weg, um mehrere Kanäle zusammenzuführen.
Zum Beispiel: playlist=0.0 spielt alle Kanäle innerhalb der Gruppe „Calm“ ab; playlist=0 spielt die gesamte Kategorie „Moods“ ab.
Antwort
Hier:
prompt,key,bpm,url— nullierbarer Stringgenerated_at,expired_at— nullierbares Datum
Um zu prüfen, ob ein Track erstellt wurde, verwenden Sie das tracks-Modell mit TRACK_ID. So geht's:
Anfrage
Oder fügen Sie Ihrer Lizenz einen Webhook hinzu und erhalten Sie Nachrichten, wenn der Vorgang abgeschlossen ist.
Text-zu-Musik
Sie können mit einem Text-Prompt und einer Reihe ausgewählter Merkmale einen Track erstellen. Diese Methode ähnelt der vorherigen, aber statt einen Kanal auszuwählen, senden Sie uns eine Textnachricht. Sie wird an das Transformer-Neuronale Netzwerk mit einer Tag-Datenbank übermittelt, und die passenden Klangsets werden automatisch ausgewählt. Danach erstellt unsere Composer-Engine einen Track und sendet Ihnen die Datei zurück.
Bevor Sie es verwenden, stellen Sie sicher, dass es gemäß der Vertragsvereinbarung aktiviert ist.
Anfrage
Parameter
prompt(Pflichtfeld) —dein Text-Prompt auf Englisch, maximal 200 Zeichenduration(Pflichtfeld) — Trackdauer in Sekundenformat(optional) —mp3oderwavbitrate(optional) — Klangqualität gemessen in kbpsintensity(optional) — Komplexität des Arrangements, es spielen gleichzeitig weniger oder mehr Instrumentemode(optional) — Kompositionstyp (track,loop)
Mögliche Werte für bitrate : 32, 96, 128, 192, 256, 320
Mögliche Werte für intensity : low, medium, high
prompt — Textaufforderung, die Sie von Ihrer Benutzereingabe oder von anderen verbundenen Eingaben (Sprachmodelle, Bild-zu-Text, Spielmechaniken usw.) erhalten können
track — bedeutet einen Track mit gemeinsamer Struktur aus Intro, Drops, Breaks und Outro
loop — steht für einen Track, der geloopt werden kann
Wenn optionale Parameter weggelassen werden oder falsche Werte enthalten, werden Standardparameter mit format=mp3, bitrate=128 , intensity=high, mode=track angewendet
Antwort
Antwortet mit 204 Kein Inhalt, wenn erfolgreich.
Intensität
Die set-intensity-URL ermöglicht das Ändern der Komplexität des Arrangements. Verschiedene Presets bestehen aus weniger oder mehr Instrumenten, die gleichzeitig spielen. Die Intensitäten wechseln nahtlos, ohne den Stream zu unterbrechen.
Mögliche Werte für Intensität : low, medium, high
Anfrage
Antwort
Antwortet mit 204 Kein Inhalt, wenn erfolgreich.
Generation neu starten
Um den Stream neu zu starten, sodass ein anderer Titel (Melodie) mit derselben url abgespielt wird, verwenden Sie die POST-Methode mit streaming/restart.
Anfrage
Antwort
Antwortet mit 204 Kein Inhalt, wenn erfolgreich.
Bild-zu-Musik
Sie können einen Track mit einem Bild erstellen. Bevor Sie ihn verwenden, stellen Sie sicher, dass er im Rahmen der Vertragsvereinbarung aktiviert ist.
Anfrage
Parameter
image(erforderlich) — Ihr Bild im JPEG/PNG-Format, maximal 10 MBduration(erforderlich) — Titeldauer in Sekundenformat(optional) — mp3 oder wavbitrate(optional) — Klangqualität gemessen in kbpsintensity(optional) — Komplexität des Arrangements, es spielen gleichzeitig weniger oder mehr Instrumentemode(optional) — Kompositionstyp (track,loop)
Mögliche Werte für bitrate : 32, 96, 128, 192, 256, 320
Mögliche Werte für intensity : low, medium, high
track — bedeutet einen Titel mit einer gemeinsamen Struktur mit Intro, Drops, Breaks und Outro
loop — steht für einen Titel, der geloopt werden kann
Wenn optionale Parameter weggelassen werden oder falsche Werte enthalten, werden Standardparameter mit format=mp3, bitrate=128 , intensity=high, mode=track angewendet
BPM-/Tonart-Generierung
Sie können bpm und Tonart zu den Generierungsparametern von playlist_index hinzufügen.
Anfrage
Antwort
Gibt bei Erfolg 200 OK mit dem track-Modell zurück.
Ähnliche generieren
Du kannst einen ähnlichen Track zu einem bestehenden generieren. Es wird nicht genau derselbe Track sein, sondern ähnlich.
Verwenden Sie POST mit https://music-api.mubert.com/api/v3/public/tracks/TRACK_ID/similar
Anfrage
Spurbearbeitung
Sie können einige Parameter eines vorhandenen Tracks ändern.
Anfrage
Antwort 200 OK
Außerdem können Sie einen Teil der Spur ersetzen. Jede Spur besteht aus Instrumenten. Die Spur kann Instrumente wie die folgenden enthalten:
SCHLAGZEUG, PERCUSSION, HI-HATS, KLATSCHER, BASS, MITTEN, LEADS, FX, GESANG, FLÄCHEN, RISER, IMPACT
Diese Instrumente können zu Stems wie
Also enthalten diese Stems die folgenden Instrumente:
DRUMSenthältDRUMS,PERCS,HATS,CLAPSBASSenthältBASSLEADSenthältMIDS,LEADS,PADSVOCALSenthältVOCALSFXenthältFX,RISER,IMPACT
Sie können sowohl das Instrument als auch den Stiel ersetzen. Instrument(e) ersetzen:
Instrument(e) ersetzen:
Stiele ersetzen:
Instrument(e) löschen:
Stängel löschen:
Alle diese Anfragen erhalten das Track-Modell.
Titelliste
Um die Track-Liste zu erhalten, verwenden Sie GET mit dem Modell tracks.
Die Antwort enthält eine Liste von Streckenmodellen.
Verwenden Sie die Seitennavigation, um alle Daten anzuzeigen.
Sie können auch Informationen zu einem bestimmten Titel erhalten.
Die Antwort enthält ein Streckenmodell.
Track-Shop
Die Track-Store-Funktion ermöglicht es Ihnen, einen Puffer mit vorab generierten Tracks zu erstellen. Sie eignet sich hervorragend, wenn Sie einen einzigartigen Track mit der genauen Dauer, dem Modus und dem Format erhalten möchten, ohne lange warten zu müssen. Wir erstellen einen Cloud-Bucket und richten einen dedizierten Generator ein, um den Prozess des Empfangens von Dateien zu beschleunigen. Mubert erstellt eine Reihe von Tracks mit einem Parametersatz und legt sie in den Bucket. Wenn Sie eine dieser Dateien verwenden, startet eine ähnliche Track-Generierung, um den Puffer zu füllen. Die Anzahl der Dateien im Bucket hängt von der durchschnittlichen Auslastung Ihres Dienstes ab. Um dies zu berechnen, benötigen wir außerdem eine Liste der folgenden Parameter von Ihnen: Modus, Dauer, Bitrate, Intensität, Format. Bitte wählen Sie die Werte dieser Parameter aus und senden Sie eine E-Mail an unseren Manager, um mit der Erstellung des Buckets fortzufahren. Außerdem können Sie Playlists auswählen, die Sie vorab generieren möchten; standardmäßig verwenden wir alle Kanäle.
Sie erhalten automatisch den Track aus dem Track Store, wenn die Anfrageparameter des Tracks mit den Parametern des Stores übereinstimmen. Bevor Sie den Track Store verwenden, stellen Sie bitte sicher, dass er gemäß der Vertragsvereinbarung aktiviert ist.
Mubert Musikbibliothek
Wir haben eine Bibliothek mit mehr als 12.000 Tracks zusammengestellt, die mithilfe von Mubert-Künstlicher Intelligenz erstellt und von unseren Musikredakteuren ausgewählt wurden.
Parameter
Verwenden Sie die GET-Methode, um Statistiken der Musikbibliothek und Parameter anzuzeigen, nach denen Sie Titel filtern können.
Anfrage
Antwort
Sie können auch Informationen zu einem bestimmten Parameter erhalten. Zum Beispiel: BPM 120
Antwort
Dies bedeutet, dass Sie 315 Titel mit BPM 120 im Thema "Сorporate", 12 Titel im Thema "Podcast", 138 Titel im Genre "Nu Disco" und 27 Titel im Genre "Folk" finden können.
Sie können mehrere Parameter angeben und dann wird ein logisches AND auf sie angewendet.
Anfrage
Antwort
In der Antwort können Sie auch die Anzahl der Tracks jeder Dauer sehen, die der Anfrage BPM 120 AND Genre Nu Disco entsprechen
Titel
Verwenden Sie die GET-Methode, um die Liste der Tracks zu erhalten.
Anfrage
Antwort
Die Antwort enthält eine Liste von Track-Modellen. Verwenden Sie die Paginierung, um alle Daten anzuzeigen. Sie können auch einen oder mehrere Parameter verwenden, um Tracks zu filtern und die am besten geeigneten zu finden. Zum Beispiel: BPM 120 AND Genre Nu Disco AND Duraton 180
Anfrage
Antwort
In der Antwort auch Liste der Track-Modelle. Verwenden Sie die Paginierung, um alle Daten zu sehen.
Selbstbewusstsein
Für weitere technische Informationen können Sie swagger verwenden: https://music-api.mubert.com/api/v3/swagger
Preisgestaltung
Versuchen Sie es für nur 49 $ pro Monat
ist jetzt live — Vertone deine Videos