Die MVSEP-API bietet programmatischen Zugang zur Erstellung einer Trennung, zum Abrufen der Ergebnisse, zur Informationsabfrage über die Website und zur Kontrolle der Benutzerberechtigungen.
Um diese API nutzen zu können, benötigen Sie einen API-Schlüssel. Sie sind nicht eingeloggt, bitte loggen Sie sich ein, um Ihr API-Token zu erhalten.
Examples in Python: https://github.com/ZFTurbo/MVSep-API-Examples
Unofficial application MacVSep for Mac OS: https://github.com/septcoco/macvsep
Webhooks can be setup here: Webhooks Page
Beachten Sie, dass Premium-Benutzer bis zu 10 gleichzeitige Jobs anfordern können, während Nicht-Premium-Benutzer nur 1 gleichzeitigen Job anfordern können.
Um eine Trennung zu erstellen, müssen Sie einen POST-Aufruf an die folgende URL tätigen:
https://mvsep.com/api/separation/create
Feld | Typ | Beschreibung |
---|---|---|
api_token | String | Ihr API-Schlüssel |
audiofile | Binary | Zu verarbeitende Audiodatei. Not required if url parameter is set |
url | String | Link to the audiofile. Not required if audiofile parameter is set |
remote_type | String | (optional) Remote type of the audiofile. Defaults to direct . Not required if audiofile parameter is set. Supported types are direct (Direct Download), mega (MEGA), drive (Google Drive), dropbox (Dropbox) |
sep_type | Integer | Separation Type, standardmäßig 11 (Demucs3 Model B (Gesang, Schlagzeug, Bass, andere)) |
add_opt1 | String | Erstes zusätzliches Feld für den Trennungstyp |
add_opt2 | String | Zweites zusätzliches Feld „Trennungstyp“. |
add_opt3 | String | (optional) Trennungsart drittes zusätzliches Feld |
output_format | Integer | Ausgabeformat, standardmäßig 0 (mp3 (320 kbps)) |
is_demo | Boolean | Sollte die Trennung auf der Demoseite veröffentlicht werden, ist der Standardwert „false“. |
Name | Wert | Additional fields |
---|---|---|
Ensemble (vocals, instrum) | 26 | Key: add_opt1 Name: Output files Options:
Key: add_opt2 Name: Model Type Options:
|
Ensemble (vocals, instrum, bass, drums, other) | 28 | Key: add_opt1 Name: Output files Options:
Key: add_opt2 Name: Model Type Options:
|
Ensemble All-In (vocals, bass, drums, piano, guitar, lead/back vocals, other) | 30 | Key: add_opt1 Name: Output files Options:
Key: add_opt2 Name: Model Type Options:
|
BS Roformer SW (vocals, bass, drums, guitar, piano, other) | 63 | |
BS Roformer (vocals, instrumental) | 40 | Key: add_opt1 Name: Vocal model type Options:
|
MelBand Roformer (vocals, instrumental) | 48 | Key: add_opt1 Name: Vocal model type Options:
|
MDX23C (vocals, instrumental) | 25 | Key: add_opt1 Name: Vocal model type Options:
|
SCNet (vocals, instrumental) | 46 | Key: add_opt1 Name: Vocal model type Options:
|
Demucs4 HT (vocals, drums, bass, other) | 20 | Key: add_opt1 Name: Model type Options:
|
MDX B (vocals, instrumental) | 23 | Key: add_opt1 Name: Vocal model type Options:
|
Ultimate Vocal Remover VR (vocals, music) | 9 | Key: add_opt1 Name: Model Type Options:
Key: add_opt2 Name: Agressiveness Options:
|
Demucs4 Vocals 2023 (vocals, instrum) | 27 | |
MelBand Karaoke (lead/back vocals) | 49 | Key: add_opt1 Name: Karaoke model type Options:
Key: add_opt2 Name: Extraction type Options:
|
MDX-B Karaoke (lead/back vocals) | 12 | Key: add_opt1 Name: Karaoke model type Options:
|
MVSep Piano (piano, other) | 29 | Key: add_opt1 Name: Piano model type Options:
|
MVSep Guitar (guitar, other) | 31 | Key: add_opt1 Name: Guitar model type Options:
|
MVSep Bass (bass, other) | 41 | Key: add_opt1 Name: Bass model type Options:
Key: add_opt2 Name: How to extract Options:
Key: add_opt3 Name: Output files Options:
|
MVSep Drums (drums, other) | 44 | Key: add_opt1 Name: Drums model type Options:
Key: add_opt2 Name: How to extract Options:
Key: add_opt3 Name: Output files Options:
|
MVSep Strings (strings, other) | 52 | |
MVSep Wind (wind, other) | 54 | Key: add_opt1 Name: Wind model type Options:
Key: add_opt2 Name: How to extract Options:
Key: add_opt3 Name: Output files Options:
|
MVSep Organ (organ, other) | 58 | Key: add_opt1 Name: Organ model type Options:
|
MVSep Saxophone (saxophone, other) | 61 | Key: add_opt1 Name: Model type Options:
|
MVSep Violin (violin, other) | 65 | |
Apollo Enhancers (by JusperLee and Lew) | 51 | Key: add_opt1 Name: Model type Options:
|
Reverb Removal (noreverb) | 22 | Key: add_opt1 Name: Model Type Options:
Key: add_opt2 Name: Preprocess Options:
|
MVSep Crowd removal (crowd, other) | 34 | Key: add_opt1 Name: Model type Options:
|
MVSep Demucs4HT DNR (dialog, sfx, music) | 24 | Key: add_opt1 Name: Model type Options:
|
BandIt Plus (speech, music, effects) | 36 | |
BandIt v2 (speech, music, effects) | 45 | Key: add_opt1 Name: Model Type Options:
|
MVSep DnR v3 (speech, music, sfx) | 56 | Key: add_opt1 Name: Model type Options:
Key: add_opt2 Name: How to extract Options:
Key: add_opt3 Name: Output files Options:
|
DrumSep (4-6 stems: kick, snare, cymbals, toms, ride, hh, crash) | 37 | Key: add_opt1 Name: Model Type Options:
Key: add_opt2 Name: Preprocess Options:
|
DeNoise by aufr33 | 47 | Key: add_opt1 Name: Model type Options:
|
Whisper (extract text from audio) | 39 | Key: add_opt1 Name: Model type Options:
Key: add_opt2 Name: Transcription type Options:
|
Parakeet (extract text from audio) | 64 | Key: add_opt1 Name: Model type Options:
|
Medley Vox (Multi-singer separation) | 53 | Key: add_opt1 Name: Model type Options:
|
MVSep Multichannel BS (vocals, instrumental) | 43 | Key: add_opt1 Name: Model Type Options:
|
MVSep Male/Female separation | 57 | Key: add_opt1 Name: Model type Options:
Key: add_opt2 Name: How to extract Options:
|
MDX A/B (vocals, drums, bass, other) | 7 | Key: add_opt1 Name: Vocal model type Options:
|
Demucs3 Model (vocals, drums, bass, other) | 10 | Key: add_opt1 Name: Model type Options:
|
Vit Large 23 (vocals, instrum) | 33 | Key: add_opt1 Name: Model type Options:
|
UVRv5 Demucs (vocals, music) | 17 | Key: add_opt1 Name: Model Type Options:
|
MVSep DNR (music, sfx, speech) | 18 | |
MVSep Vocal Model (vocals, music) | 19 | |
Demucs2 (vocals, drums, bass, other) | 13 | |
Danna Sep (vocals, drums, bass, other) | 15 | |
Byte Dance (vocals, drums, bass, other) | 16 | |
MVSep MelBand Roformer (vocals, instrum) | 35 | |
spleeter | 0 | Key: add_opt1 Name: Model type Options:
|
UnMix | 3 | Key: add_opt1 Name: Model type Options:
|
Zero Shot (Query Based) (Low quality) | 14 | Key: add_opt1 Name: Model Type Options:
|
LarsNet (kick, snare, cymbals, toms, hihat) | 38 | Key: add_opt1 Name: Model type Options:
|
Stable Audio Open Gen | 62 | Key: add_opt1 Name: Text prompt Options: Key: add_opt2 Name: Length (in seconds) Options:
|
MVSep MultiSpeaker (MDX23C) | 42 | Key: add_opt1 Name: Model Type Options:
|
Aspiration (by Sucial) | 50 | Key: add_opt1 Name: Model type Options:
|
AudioSR (Super Resolution) | 59 | Key: add_opt1 Name: Cutoff (Hz) Options:
|
Phantom Centre extraction (by wesleyr36) | 55 | |
FlashSR (Super Resolution) | 60 |
Name | Wert |
---|---|
mp3 (320 kbps) | 0 |
wav (uncompressed, 16 bit) | 1 |
flac (lossless, 16 bit) | 2 |
m4a (lossy) | 3 |
wav (uncompressed, 32 bit) | 4 |
flac (lossless, 24 bit) | 5 |
curl --location --request POST 'https://mvsep.com/api/separation/create'
--form 'audiofile=@"/path/to/file.mp3"'
--form 'api_token="<Ihr API-Token>"'
--form 'sep_type="9"'
--form 'add_opt1="0"'
--form 'add_opt2="1"'
--form 'output_format="1"'
--form 'is_demo="1"'
Schlüssel | Wert |
---|---|
success |
|
data | Hält zusätzliche Informationen abhängig vom success-Schlüssel |
data -> link | Zeigt einen Link zur "GET RESULT"-URL des erstellten Jobs an (nur angezeigt, wenn success true ist) |
data -> hash | Zeigt den Hash des erstellten Jobs an (nur angezeigt, wenn success true ist) |
data -> message | Zeigt die Beschreibung eines Fehlers an (nur angezeigt, wenn success false ist) |
Die MVSEP-API verwendet die folgenden Fehlercodes:
Fehlercode | Bedeutung |
---|---|
400 | Einige Parameter fehlen oder sind ungültig. Dieser Fehler tritt auf, wenn Sie nicht alle obligatorischen Parameter oder ungültige Parameter übergeben. |
401 |
Unbekannter oder ungültiger api_token . Dieser Fehler erscheint, wenn Sie einen unbekannten API-Schlüssel verwenden
|
Um das Trennungsergebnis zu erhalten, müssen Sie einen GET-Aufruf an die folgende URL durchführen:
https://mvsep.com/api/separation/get
Feld | Typ | Beschreibung |
---|---|---|
hash | String | Trennungs-Hash |
mirror | Integer | (optional) Verwendet einen anderen Mirror, wenn auf 1 gesetzt, standardmäßig 0. Erfordert api_token und 1 Kredit, wenn auf 1 gesetzt. |
api_token | string | (optional) API-Schlüssel des Benutzers. Erforderlich, wenn der Mirror-Parameter auf 1 gesetzt ist. |
curl --location --request GET 'https://mvsep.com/api/separation/get?hash=20230327071601-0e3e5c6c85-13-dimensions.mp3'
Schlüssel | Wert |
---|---|
success |
|
status |
|
data | Hält zusätzliche Informationen je nach dem status-Schlüssel |
data -> queue_count | Zeigt die Anzahl der nicht verarbeiteten Jobs in der Benutzerpriorität an (wird nur angezeigt, wenn der status auf waiting oder distributing gesetzt ist) |
data -> current_order | Zeigt die Reihenfolge des Benutzerjobs an (wird nur angezeigt, wenn der status auf waiting oder distributing gesetzt ist) |
data -> message | Zeigt die Beschreibung des Status an (wird bei allen Status angezeigt, zeigt stattdessen den Fehlergrund an, wenn der status auf failed gesetzt ist) |
data -> algorithm | Zeigt den verwendeten Algorithmus für den Job an (wird nur angezeigt, wenn der status auf done gesetzt ist) |
data -> algorithm_description | Zeigt die Details des verwendeten Algorithmus für den Job an (wird nur angezeigt, wenn der status auf done gesetzt ist) |
data -> output_format | Zeigt das Ausgabeformat des Jobs an (wird nur angezeigt, wenn der status auf done gesetzt ist) |
data -> tags | Zeigt die Audio-Meta-Tags an (wird nur angezeigt, wenn der status auf done gesetzt ist) |
data -> input_file | Zeigt die Details zum Download der Eingabe-Audiodatei an (wird nur angezeigt, wenn der status auf done gesetzt ist) |
data -> files | Zeigt die Details zum Download der Ausgabedateien an (wird nur angezeigt, wenn der status auf done gesetzt ist) |
data -> date | Zeigt das Verarbeitungsdatum des Jobs an (wird nur angezeigt, wenn der status auf done gesetzt ist) |
data -> finished_chunks | Zeigt die Anzahl der fertigen Teile eines großen Jobs an (wird nur angezeigt, wenn der status auf distributing gesetzt ist) |
data -> all_chunks | Zeigt die Gesamtzahl der Teile eines großen Jobs an (wird nur angezeigt, wenn der status auf distributing gesetzt ist) |
To get the result of remote job, you need to make a GET call to the following url:
https://mvsep.com/api/separation/get-remote
Feld | Typ | Beschreibung |
---|---|---|
hash | String | Trennungs-Hash |
curl --location --request GET 'https://mvsep.com/api/separation/get-remote?hash=n2AwBjy4KsFZfqqR'
Schlüssel | Wert |
---|---|
success |
|
status |
|
data | Hält zusätzliche Informationen je nach dem status-Schlüssel |
data -> queue_count | Shows unprocessed jobs count in user's priority (only shown when status is waiting ) |
data -> current_order | Shows the order of user's job (only shown when status is waiting ) |
data -> message | Shows the description of status (only when status is failed ) |
data -> link | Shows link to "GET RESULT" URL of created job (only shown when status is done ) |
data -> hash | Hash of the separation (only shown when status is done ) |
To cancel the separation and refund used credits (if the separation is not being processed yet), you need to make a POST call to the following url:
https://mvsep.com/api/separation/cancel
Feld | Typ | Beschreibung |
---|---|---|
api_token | string | API-Schlüssel des Benutzers |
hash | string | Trennungs-Hash |
curl --location --request POST 'https://mvsep.com/api/separation/cancel' --form 'api_token="<Ihr API-Token>"' --form 'hash="<hash>"'
Schlüssel | Wert |
---|---|
success |
|
Um detaillierte Daten über Trennungstypen zu erhalten, müssen Sie einen GET-Aufruf an die folgende URL machen:
https://mvsep.com/api/app/algorithms
curl --location --request GET 'https://mvsep.com/api/app/algorithms'
Gibt die Daten als Array zurück:
Schlüssel | Wert |
---|---|
render_id | Wert des Trennungstyps (ID) |
name | Name des Trennungstyps |
algorithm_group_id |
Die Gruppe, zu der der Trennungstyp gehört:
|
orientation |
Für wen dieser Trennungstyp bestimmt ist:
|
order_id | Die Reihenfolge des Trennungstyps |
price_coefficient |
Wird verwendet, um zu berechnen, wie viele Credits ein Job von einem Premium-Benutzer verbraucht. Verwendet diese Formel: : floor(<Dauer der Audiodatei in Sekunden> * price_coefficient / 60)?:1
|
usage | Shows monthly usage count of separation type |
rating | Shows monthly usage rating of separation type as array:
|
algorithm_fields | Enthält Informationen zu zusätzlichen Feldern des Trennungstyps |
algorithm_fields -> name |
Zeigt welches zusätzliche Feld des Trennungstyps:
|
algorithm_fields -> text | Anzeigename des zusätzlichen Feldes des Trennungstyps. |
algorithm_fields -> options | JSON-codierte Schlüssel-Wert-Paare des zusätzlichen Feldes |
algorithm_fields -> default_key | Standardwert des zusätzlichen Feldes. Einer der Schlüssel von <code>algorithm_fields -> options</code> |
algorithm_descriptions | Enthält Informationen über die Beschreibungen des Trennungstyps |
algorithm_descriptions -> short_description | Kurze Beschreibung des Trennungstyps, die kein HTML verwendet. |
algorithm_descriptions -> long_description | Detaillierte Beschreibung des Trennungstyps, die HTML verwendet. |
algorithm_descriptions -> lang | Festgelegter Sprachcode der Beschreibung. |
Um Informationen über die neuesten Nachrichten zu MVSEP zu erhalten, müssen Sie einen GET-Aufruf an die folgende URL machen:
https://mvsep.com/api/app/news
Feld | Typ | Beschreibung |
---|---|---|
lang | String | (optional) 2-Buchstaben-Sprachcode (en, ru) |
start | Integer | (optional) Startpunkt-Offset, standardmäßig 0 (d. h. Start bei den neuesten) |
limit | Integer | (optional) Maximale Anzahl der zurückgegebenen Ergebnisse, standardmäßig 10, maximal 20. |
curl --location --request GET 'https://mvsep.com/api/app/news?lang=en&start=2&limit=1'
Gibt die Daten als Array zurück:
Schlüssel | Wert |
---|---|
title | Titel der Nachricht |
lang | Titel der Nachricht |
text | Vollständige Beschreibung der Nachricht |
created_at | Datum der Nachricht |
To get site queue information, you need to make a GET call to the following url:
https://mvsep.com/api/app/queue
Feld | Typ | Beschreibung |
---|---|---|
api_token | String | (optional) API-Schlüssel des Benutzers |
curl --location --request GET 'https://mvsep.com/api/app/queue'
Schlüssel | Wert |
---|---|
queue |
Contains array of current queues for different plans:
|
plan |
Contains current queue for current plan (add api_token to request for registered/premium plan):
|
Um Informationen über Demo-Trennungen zu erhalten, müssen Sie einen GET-Aufruf an die folgende URL machen:
https://mvsep.com/api/app/demo
Feld | Typ | Beschreibung |
---|---|---|
start | Integer | (optional) Startpunkt-Offset, standardmäßig 0 (d. h. Start bei den neuesten) |
limit | Integer | (optional) Maximale Anzahl der zurückgegebenen Ergebnisse, standardmäßig 10, maximal 20. |
curl --location --request GET 'https://mvsep.com/api/app/demo?start=0&limit=2'
Gibt die Daten als Array zurück:
Schlüssel | Wert |
---|---|
hash | Trennungs-Hash |
date | Datum der Trennung |
input_audio | Input-Audio-URL |
size | Input-Audio-Größe |
algorithm | Enthält grundlegende Informationen über den verwendeten Trennungstyp (siehe den Tab "GET SEPARATION TYPES" für Informationen zu den zurückgegebenen Parametern) |
Um den Benutzer zu authentifizieren und den API-Schlüssel des Benutzers zu erhalten, müssen Sie einen POST-Aufruf an die folgende URL machen:
https://mvsep.com/api/app/login
Feld | Typ | Beschreibung |
---|---|---|
String | Email des Benutzers | |
password | String | Passwort des Benutzers |
curl --location --request POST 'https://mvsep.com/api/app/login' --form 'email="<Email des Benutzers>"' --form 'password="<Passwort des Benutzers>"'
Schlüssel | Wert |
---|---|
success |
|
data | Enthält Informationen, wenn die Anmeldedaten gültig sind |
data -> name | Name des Benutzers |
data -> email | Email des Benutzers |
data -> api_token | Der API-Schlüssel des Benutzers. Stellen Sie sicher, dass er in sicherer Speicherung aufbewahrt wird und für nachfolgende Operationen verwendet wird. |
data -> premium_minutes | Verbleibende Credits des Benutzers |
data -> premium_enabled |
Ob dem Benutzer die Verwendung von Credits erlaubt ist:
|
data -> long_filenames_enabled |
Ob der Benutzer zusätzliche Informationen in Dateinamen möchte:
|
Die MVSEP-API verwendet die folgenden Fehlercodes:
Fehlercode | Bedeutung |
---|---|
400 | Ungültige Anmeldedaten angegeben |
Um einen Benutzer auf der MVSEP-Website zu registrieren, müssen Sie einen POST-Aufruf an die folgende URL machen:
https://mvsep.com/api/app/register
Feld | Typ | Beschreibung |
---|---|---|
name | String | Name des Benutzers |
String | Email des Benutzers | |
password | String | Passwort des Benutzers |
password_confirmation | String | Passwort des Benutzers wiederholen |
curl --location --request GET 'https://mvsep.com/api/app/register' --form 'name="user"'
--form 'email="asdf@example.com"'
--form 'password="ASDFQWEr123"'
--form 'password_confirmation="ASDFQWEr123"'
Schlüssel | Wert |
---|---|
success |
|
message | Tritt auf, wenn das Formular gültig ist |
Die MVSEP-API verwendet die folgenden Fehlercodes:
Fehlercode | Bedeutung |
---|---|
400 | Formular ist ungültig |
Um Benutzerinformationen zu erhalten, müssen Sie einen GET-Aufruf an die folgende URL machen:
https://mvsep.com/api/app/user
Feld | Typ | Beschreibung |
---|---|---|
api_token | String | API-Schlüssel des Benutzers |
curl --location --request GET 'https://mvsep.com/api/app/user?api_token=<Ihr API-Token>'
Schlüssel | Wert |
---|---|
success |
|
data | Enthält Informationen, wenn die Anmeldedaten gültig sind |
data -> name | Name des Benutzers |
data -> email | Email des Benutzers |
data -> api_token | Der API-Schlüssel des Benutzers. Stellen Sie sicher, dass er in sicherer Speicherung aufbewahrt wird und für nachfolgende Operationen verwendet wird. |
data -> premium_minutes | Verbleibende Credits des Benutzers |
data -> premium_enabled |
Ob dem Benutzer die Verwendung von Credits erlaubt ist:
|
data -> long_filenames_enabled |
Ob der Benutzer zusätzliche Informationen in Dateinamen möchte:
|
data -> current_queue | Zeigt laufende Trennungen für den Benutzer an |
Die MVSEP-API verwendet die folgenden Fehlercodes:
Fehlercode | Bedeutung |
---|---|
400 | Ungültiger API-Schlüssel |
Um grundlegende Informationen zur Trennungshistorie des Benutzers zu erhalten, müssen Sie einen GET-Aufruf an die folgende URL machen:
https://mvsep.com/api/app/separation_history
Feld | Typ | Beschreibung |
---|---|---|
api_token | String | API-Schlüssel des Benutzers |
start | Integer | (optional) Startpunkt-Offset, standardmäßig 0 (d. h. Start bei den neuesten) |
limit | Integer | (optional) Maximale Anzahl der zurückgegebenen Ergebnisse, standardmäßig 10, maximal 20. |
curl --location --request GET 'https://mvsep.com/api/app/separation_history?api_token=<Ihr API-Token>&start=1&limit=2'
Schlüssel | Wert |
---|---|
success |
|
data | Enthält ein Array grundlegender Informationen über frühere Trennungen |
data -> hash | Trennungs-Hash |
data -> job_exists | Enthält ein Array grundlegender Informationen über frühere Trennungen |
data -> credits | Wie viele Credits für den Job verwendet wurden, wenn die Trennung nicht mehr existiert. |
data -> time_left | Ungefähre verbleibende Zeit, bis der Job gelöscht wird |
data -> algorithm | Enthält grundlegende Informationen über den verwendeten Trennungstyp (siehe den Tab "GET SEPARATION TYPES" für Informationen zu den zurückgegebenen Parametern) |
Die MVSEP-API verwendet die folgenden Fehlercodes:
Fehlercode | Bedeutung |
---|---|
400 | Ungültiger API-Schlüssel |
Um die Premium-Nutzung für den Benutzer zu aktivieren, müssen Sie einen POST-Aufruf an die folgende URL machen:
https://mvsep.com/api/app/enable_premium
Feld | Typ | Beschreibung |
---|---|---|
api_token | String | API-Schlüssel des Benutzers |
curl --location --request POST 'https://mvsep.com/api/app/enable_premium' --form 'api_token="<Ihr API-Token>"'
Schlüssel | Wert |
---|---|
success |
|
message | Informiert über den Status der Operation |
Die MVSEP-API verwendet die folgenden Fehlercodes:
Fehlercode | Bedeutung |
---|---|
400 | Ungültiger API-Schlüssel |
Um die Premium-Nutzung für den Benutzer zu deaktivieren, müssen Sie einen POST-Aufruf an die folgende URL machen:
https://mvsep.com/api/app/disable_premium
Feld | Typ | Beschreibung |
---|---|---|
api_token | String | API-Schlüssel des Benutzers |
curl --location --request POST 'https://mvsep.com/api/app/disable_premium' --form 'api_token="<Ihr API-Token>"'
Schlüssel | Wert |
---|---|
success |
|
message | Informiert über den Status der Operation |
Die MVSEP-API verwendet die folgenden Fehlercodes:
Fehlercode | Bedeutung |
---|---|
400 | Ungültiger API-Schlüssel |
Um lange Dateinamen für den Benutzer zu aktivieren, müssen Sie einen POST-Aufruf an die folgende URL machen:
https://mvsep.com/api/app/enable_long_filenames
Feld | Typ | Beschreibung |
---|---|---|
api_token | String | API-Schlüssel des Benutzers |
curl --location --request POST 'https://mvsep.com/api/app/enable_long_filenames' --form 'api_token="<Ihr API-Token>"'
Schlüssel | Wert |
---|---|
success |
|
message | Informiert über den Status der Operation |
Die MVSEP-API verwendet die folgenden Fehlercodes:
Fehlercode | Bedeutung |
---|---|
400 | Ungültiger API-Schlüssel |
Um lange Dateinamen für den Benutzer zu deaktivieren, müssen Sie einen POST-Aufruf an die folgende URL machen:
https://mvsep.com/api/app/disable_long_filenames
Feld | Typ | Beschreibung |
---|---|---|
api_token | String | API-Schlüssel des Benutzers |
curl --location --request POST 'https://mvsep.com/api/app/disable_long_filenames' --form 'api_token="<Ihr API-Token>"'
Schlüssel | Wert |
---|---|
success |
|
message | Informiert über den Status der Operation |
Die MVSEP-API verwendet die folgenden Fehlercodes:
Fehlercode | Bedeutung |
---|---|
400 | Ungültiger API-Schlüssel |
To get information about Quality Checker queue entries, you need to make a GET call to the following url:
https://mvsep.com/api/quality_checker/queue
Feld | Typ | Beschreibung |
---|---|---|
start | Integer | (optional) Startpunkt-Offset, standardmäßig 0 (d. h. Start bei den neuesten) |
limit | Integer | (optional) Maximale Anzahl der zurückgegebenen Ergebnisse, standardmäßig 10, maximal 20. |
curl --location --request GET 'https://mvsep.com/api/quality_checker/queue?&start=1&limit=2'
Gibt die Daten als Array zurück:
Schlüssel | Wert |
---|---|
id | Identification number of entry |
dataset_type | Dataset Type chosen when adding the entry / Leaderboard type
|
date | Created date of the entry |
algo_name | Name of the used separation type/algorithm |
main_text | Description of the used separation type/algorithm |
proc | Status of the processing
|
proc_remote_date | Timestamp of processing date |
msg | Returns "OK" if successful, otherwise shows error message |
metrics | Information about entry metrics |
sdr_* (wildcard) | SDR of the corresponding stems |
dataset_name | Name of the dataset |
To get information about Quality Checker leaderboards, you need to make a GET call to the following url:
https://mvsep.com/api/quality_checker/leaderboard
Feld | Typ | Beschreibung |
---|---|---|
dataset_type | String | Dataset Type, defaults to 0 if not given
|
start | Integer | (optional) Startpunkt-Offset, standardmäßig 0 (d. h. Start bei den neuesten) |
limit | Integer | (optional) Maximale Anzahl der zurückgegebenen Ergebnisse, standardmäßig 10, maximal 20. |
algo_name_filter | String | Filters Separation Type/Algorithm names by given text |
sort | String | Sort by given SDR of the stem. You can get list of sortable values for given dataset type from sortables key in response |
curl --location --request GET 'https://mvsep.com/api/quality_checker/leaderboard?&start=1&limit=2&algo_name_filter=MVSep'
Schlüssel | Wert |
---|---|
data | Contains array of Quality Checker entries. Refer to GET QUEUE response from Quality Checker Section for more information |
dataset_type | Used dataset type key |
sortables | Keys that can be used to sort used dataset type by given stem in sequential order. |
sort | Used sorting key from sortable. |
To create Quality Checker entry, you need to make a POST call to the following url:
https://mvsep.com/api/quality_checker/add
Feld | Typ | Beschreibung |
---|---|---|
api_token | String | (required) Ihr API-Schlüssel |
zipfile | Binary | (required) Zip file to be processed |
algo_name | String | (required) Name of the algorithm |
main_text | String | (required) Description of the algorithm |
dataset_type | String | Dataset type. Defaults to 0 .
|
password | String | (required) Password to delete algorithm |
ensemble | integer | 0 - algorithm is not ensemble. 1 - algorithm is ensemble. |
curl --location 'https://mvsep.com/api/quality_checker/add' --form 'zipfile=@"/path/to/zipfile"' --form 'algo_name="Test Algorithm Name"' --form 'main_text="Test Algorithm Description"' --form 'dataset_type="2"' --form 'ensemble="1"' --form 'password="test"'
Schlüssel | Wert |
---|---|
success |
|
data | Contains information about entry |
data -> id | ID of the entry. |
data -> link | Link to the entry. |
Die MVSEP-API verwendet die folgenden Fehlercodes:
Fehlercode | Bedeutung |
---|---|
400 | Formular ist ungültig |
401 |
Unbekannter oder ungültiger api_token . Dieser Fehler erscheint, wenn Sie einen unbekannten API-Schlüssel verwenden
|
To get information about Quality Checker queue entry by id, you need to make a GET call to the following url:
https://mvsep.com/api/quality_checker/entry
Feld | Typ | Beschreibung |
---|---|---|
id | Integer | (required) ID of the entry |
curl --location --request GET 'https://mvsep.com/api/quality_checker/entry?id=7675'
To delete Quality Checker queue entry by id and password, you need to make a GET call to the following url:
https://mvsep.com/api/quality_checker/delete
Feld | Typ | Beschreibung |
---|---|---|
id | Integer | (required) ID of the entry |
password | String | (required) Used password for the entry |
curl --location 'https://mvsep.com/api/quality_checker/delete' --form 'id="7720"' --form 'password="test"'
Schlüssel | Wert |
---|---|
success |
|
data->message | Shows whether entry was deleted |
turbo@mvsep.com