Az MVSEP API programozott hozzáférést biztosít az elválasztás létrehozásához, az eredmények visszaadásához, a webhely információinak lekéréséhez és a felhasználói képességek szabályozásához.
Az API használatához API-kulcsra van szüksége. Nincs bejelentkezve, kérjük, jelentkezzen be, hogy megkapja API-tokenjét.
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
Vegye figyelembe, hogy a prémium felhasználók legfeljebb 10 egyidejű munkát kérhetnek, míg a nem prémium felhasználók csak 1 egyidejű munkát.
Az elválasztás létrehozásához POST-hívást kell indítania a következő URL-re:
https://mvsep.com/api/separation/create
Terület | típus | Leírás |
---|---|---|
api_token | String | Az Ön API-kulcsa |
audiofile | Binary | Feldolgozandó audiofájl. 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 | (opcionális) Elválasztási típus, alapértelmezés szerint 11 (Demucs3 Model B (ének, dob, basszusgitár, egyéb)) |
add_opt1 | String | (nem kötelező) Elválasztás típusa az első további mező |
add_opt2 | String | (nem kötelező) Elválasztás típusa második kiegészítő mező |
add_opt3 | String | (választható) Elkülönítési típus harmadik kiegészítő mező |
output_format | Integer | (opcionális) kimeneti formátum, alapértelmezés szerint 0 (mp3 (320 kbps)) |
is_demo | Boolean | (opcionális), ha az elválasztást közzé kell tenni a bemutató oldalon, az alapértelmezett érték false |
Név | Érték | 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 |
Név | Érték |
---|---|
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="<Az API-tokenje>"'
--form 'sep_type="9"'
--form 'add_opt1="0"'
--form 'add_opt2="1"'
--form 'output_format="1"'
--form 'is_demo="1"'
Kulcs | Érték |
---|---|
success |
|
data | A siker kulcs függvényében további információkat tartalmaz. |
data -> link | Megjeleníti a létrehozott feladat "EREDMÉNY SZEREZÉSE" URL-címére mutató hivatkozást (csak akkor jelenik meg, ha a siker igaz ) |
data -> hash | Megjeleníti a létrehozott feladatkivonatot (csak akkor jelenik meg, ha a siker igaz ) |
data -> message | Megjeleníti a hiba leírását (csak akkor jelenik meg, ha a siker hamis ) |
Az MVSEP API a következő hibakódokat használja:
Hibakód | Jelentése |
---|---|
400 | Néhány paraméter hiányzik vagy érvénytelen. Ez a hiba akkor jelenik meg, ha nem ad át minden kötelező paramétert, vagy érvénytelen paramétereket ad át. |
401 |
Ismeretlen vagy érvénytelen api_token . Ez a hiba akkor jelenik meg, ha ismeretlen API-kulcsot használ
|
Az elválasztás eredményének eléréséhez GET-hívást kell indítania a következő URL-re:
https://mvsep.com/api/separation/get
Terület | típus | Leírás |
---|---|---|
hash | String | Elválasztás Hash |
mirror | Integer | (opcionális) Egy másik tükröt használ, ha 1-re van állítva, alapértelmezés szerint 0. Ha 1-re van állítva, api_token és 1 kredit szükséges. |
api_token | string | (opcionális) a felhasználó API-kulcsa. Szükséges, ha a tükrözési paraméter 1-re van állítva. |
curl --location --request GET 'https://mvsep.com/api/separation/get?hash=20230327071601-0e3e5c6c85-13-dimensions.mp3'
Kulcs | Érték |
---|---|
success |
|
status |
|
data | Az állapot billentyűtől függően további információkat tárol |
data -> queue_count | Megjeleníti a feldolgozatlan munkák számát a felhasználó prioritásában (csak akkor jelenik meg, ha az állapot várakozik vagy elosztás ) |
data -> current_order | Megjeleníti a felhasználó feladatának sorrendjét (csak akkor jelenik meg, ha az állapot várakozik vagy elosztás ) |
data -> message | Megjeleníti az állapot leírását (minden állapotnál megjelenik, helyette a hiba okát mutatja, ha az állapot sikertelen ) |
data -> algorithm | Megjeleníti a munkánál használt algoritmust (csak akkor jelenik meg, ha az állapot kész ) |
data -> algorithm_description | Megjeleníti a munkához használt algoritmus részleteit (csak akkor jelenik meg, ha az állapot kész ) |
data -> output_format | Megjeleníti a feladat kimeneti formátumát (csak akkor jelenik meg, ha az állapot kész ) |
data -> tags | Megjeleníti az audio metacímkéket (csak akkor jelenik meg, ha az állapot kész ) |
data -> input_file | Megjeleníti a bemeneti hangletöltés részleteit (csak akkor jelenik meg, ha az állapot kész ) |
data -> files | Megjeleníti a kimeneti hangok letöltésének részleteit (csak akkor jelenik meg, ha az állapot kész ) |
data -> date | Megjeleníti a munka feldolgozási dátumát (csak akkor jelenik meg, ha az állapot kész ) |
data -> finished_chunks | Egy nagy feladat befejezett részeinek számát mutatja (csak akkor jelenik meg, ha az státusz elosztás ) |
data -> all_chunks | Egy nagy feladat összes részének számát mutatja (csak akkor jelenik meg, ha az állapot elosztás ) |
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
Terület | típus | Leírás |
---|---|---|
hash | String | Elválasztás Hash |
curl --location --request GET 'https://mvsep.com/api/separation/get-remote?hash=n2AwBjy4KsFZfqqR'
Kulcs | Érték |
---|---|
success |
|
status |
|
data | Az állapot billentyűtől függően további információkat tárol |
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
Terület | típus | Leírás |
---|---|---|
api_token | string | A felhasználó API kulcsa |
hash | string | Elválasztás Hash |
curl --location --request POST 'https://mvsep.com/api/separation/cancel' --form 'api_token="<Az API-tokenje>"' --form 'hash="<hash>"'
Kulcs | Érték |
---|---|
success |
|
Az elválasztási típusok részletes adatainak megtekintéséhez GET-hívást kell indítania a következő URL-re:
https://mvsep.com/api/app/algorithms
curl --location --request GET 'https://mvsep.com/api/app/algorithms'
Az adatokat tömbként adja vissza:
Kulcs | Érték |
---|---|
render_id | Elválasztás típusának értéke (ID) |
name | Az elválasztás típusának neve |
algorithm_group_id |
A csoport, ahová az elválasztás típusa tartozik:
|
orientation |
Kinek szól ez az elválasztási típus:
|
order_id | Az elválasztás típusának sorrendje |
price_coefficient |
Arra szolgál, hogy kiszámítsa, hány kreditet vesz fel a munka a prémium felhasználótól. Ezt a képletet használja : floor(<audiofájl időtartama másodpercben> * price_coefficient / 60)?:1
|
usage | Shows monthly usage count of separation type |
rating | Shows monthly usage rating of separation type as array:
|
algorithm_fields | Információkat tartalmaz az elválasztás típusú további mezőkről |
algorithm_fields -> name |
Megmutatja, hogy az elválasztástípus melyik további mezője:
|
algorithm_fields -> text | Az elválasztástípus kiegészítő mezőjének megjelenítési neve. |
algorithm_fields -> options | További mezők JSON kódolt kulcsértékláncai |
algorithm_fields -> default_key | A kiegészítő mező alapértelmezett értéke. Az <code>algorithm_fields -> options</code> egyik kulcsa |
algorithm_descriptions | Információkat tartalmaz az elválasztás típusának leírásáról |
algorithm_descriptions -> short_description | A HTML-t nem használó elválasztási típus kis leírása. |
algorithm_descriptions -> long_description | A HTML-t használó elválasztási típus részletes leírása. |
algorithm_descriptions -> lang | A leírás megadott nyelvi kódja. |
Az MVSEP-pel kapcsolatos legfrissebb hírekről való tájékoztatáshoz GET-hívást kell kezdeményeznie a következő URL-címen:
https://mvsep.com/api/app/news
Terület | típus | Leírás |
---|---|---|
lang | String | (nem kötelező) 2 betűs nyelvi kód (en, ru) |
start | Integer | (opcionális) Kezdőpont eltolás, alapértelmezés szerint 0 (azaz a legkésőbbi kezdettől) |
limit | Integer | (nem kötelező) A visszaadott találatok maximális száma, alapértelmezés szerint 10, maximum 20. |
curl --location --request GET 'https://mvsep.com/api/app/news?lang=en&start=2&limit=1'
Az adatokat tömbként adja vissza:
Kulcs | Érték |
---|---|
title | A hírek címe |
lang | A hírek címe |
text | A hír teljes leírása |
created_at | A hírek dátuma |
To get site queue information, you need to make a GET call to the following url:
https://mvsep.com/api/app/queue
Terület | típus | Leírás |
---|---|---|
api_token | String | (optional) A felhasználó API kulcsa |
curl --location --request GET 'https://mvsep.com/api/app/queue'
Kulcs | Érték |
---|---|
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):
|
Ha információt szeretne kapni a demó szétválasztásról, GET-hívást kell indítania a következő URL-re:
https://mvsep.com/api/app/demo
Terület | típus | Leírás |
---|---|---|
start | Integer | (opcionális) Kezdőpont eltolás, alapértelmezés szerint 0 (azaz a legkésőbbi kezdettől) |
limit | Integer | (nem kötelező) A visszaadott találatok maximális száma, alapértelmezés szerint 10, maximum 20. |
curl --location --request GET 'https://mvsep.com/api/app/demo?start=0&limit=2'
Az adatokat tömbként adja vissza:
Kulcs | Érték |
---|---|
hash | Elválasztás Hash |
date | A szétválás dátuma |
input_audio | Adja meg a hang URL-címét |
size | Bemeneti hangméret |
algorithm | Alapvető információkat tartalmaz a használt elválasztási típusról (a visszaadott paraméterekkel kapcsolatos információkért tekintse meg az ELKEVÁLASZTÁSI TÍPUSOK BESZERZÉSE lapot) |
A felhasználó hitelesítéséhez és a felhasználó API-kulcsának lekérdezéséhez POST-hívást kell indítanod a következő url-re:
https://mvsep.com/api/app/login
Terület | típus | Leírás |
---|---|---|
String | A felhasználó e-mail címe | |
password | String | A felhasználó jelszava |
curl --location --request POST 'https://mvsep.com/api/app/login' --form 'email="<A felhasználó e-mail címe>"' --form 'password="<A felhasználó jelszava>"'
Kulcs | Érték |
---|---|
success |
|
data | Információt tartalmaz, ha a hitelesítő adatok érvényesek |
data -> name | A felhasználó neve |
data -> email | A felhasználó e-mail címe |
data -> api_token | A felhasználó API-kulcsa. Győződj meg róla, hogy biztonságos tárolóhelyen tárolod, és használd későbbi műveletekhez. |
data -> premium_minutes | A felhasználónak megmaradt kreditek |
data -> premium_enabled |
A felhasználó engedélyezte-e a kreditek elköltését.
|
data -> long_filenames_enabled |
Kíván-e a felhasználó extra információkat a fájlnevekben:
|
Az MVSEP API a következő hibakódokat használja:
Hibakód | Jelentése |
---|---|
400 | Helytelen hitelesítő adatok lettek megadva |
A felhasználó MVSEP oldalra történő regisztrálásához POST hívást kell indítanod a következő url-re:
https://mvsep.com/api/app/register
Terület | típus | Leírás |
---|---|---|
name | String | A felhasználó neve |
String | A felhasználó e-mail címe | |
password | String | A felhasználó jelszava |
password_confirmation | String | Ismételd meg a felhasználó jelszavát |
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"'
Kulcs | Érték |
---|---|
success |
|
message | Akkor következik be, ha az űrlap érvényes |
Az MVSEP API a következő hibakódokat használja:
Hibakód | Jelentése |
---|---|
400 | Az űrlap érvénytelen |
A felhasználói adatok lekérdezéséhez GET-hívást kell indítanod a következő url-re:
https://mvsep.com/api/app/user
Terület | típus | Leírás |
---|---|---|
api_token | String | A felhasználó API kulcsa |
curl --location --request GET 'https://mvsep.com/api/app/user?api_token=<Az API-tokenje>'
Kulcs | Érték |
---|---|
success |
|
data | Információt tartalmaz, ha a hitelesítő adatok érvényesek |
data -> name | A felhasználó neve |
data -> email | A felhasználó e-mail címe |
data -> api_token | A felhasználó API-kulcsa. Győződj meg róla, hogy biztonságos tárolóhelyen tárolod, és használd későbbi műveletekhez. |
data -> premium_minutes | A felhasználónak megmaradt kreditek |
data -> premium_enabled |
A felhasználó engedélyezte-e a kreditek elköltését.
|
data -> long_filenames_enabled |
Kíván-e a felhasználó extra információkat a fájlnevekben:
|
data -> current_queue | Megjeleníti a folyamatban lévő elválasztásokat a felhasználó számára |
Az MVSEP API a következő hibakódokat használja:
Hibakód | Jelentése |
---|---|
400 | Érvénytelen API kulcs |
Ahhoz, hogy alapinformációkat kapj a felhasználó elkülönítéseinek előzményeiről, egy GET hívást kell indítanod a következő url-re:
https://mvsep.com/api/app/separation_history
Terület | típus | Leírás |
---|---|---|
api_token | String | A felhasználó API kulcsa |
start | Integer | (opcionális) Kezdőpont eltolás, alapértelmezés szerint 0 (azaz a legkésőbbi kezdettől) |
limit | Integer | (nem kötelező) A visszaadott találatok maximális száma, alapértelmezés szerint 10, maximum 20. |
curl --location --request GET 'https://mvsep.com/api/app/separation_history?api_token=<Az API-tokenje>&start=1&limit=2'
Kulcs | Érték |
---|---|
success |
|
data | Alapvető információkat tartalmaz a korábbi elválasztásokról |
data -> hash | Elválasztás Hash |
data -> job_exists | Alapvető információkat tartalmaz a korábbi elválasztásokról |
data -> credits | Hány kreditpontot használtak fel a feladathoz, null, ha nem létezik az elkülönítés. |
data -> time_left | A feladat törléséig hátralévő becsült idő |
data -> algorithm | Alapvető információkat tartalmaz a használt elválasztási típusról (a visszaadott paraméterekkel kapcsolatos információkért tekintse meg az ELKEVÁLASZTÁSI TÍPUSOK BESZERZÉSE lapot) |
Az MVSEP API a következő hibakódokat használja:
Hibakód | Jelentése |
---|---|
400 | Érvénytelen API kulcs |
A felhasználó prémiumhasználatának engedélyezéséhez POST-hívást kell indítanod a következő url-re:
https://mvsep.com/api/app/enable_premium
Terület | típus | Leírás |
---|---|---|
api_token | String | A felhasználó API kulcsa |
curl --location --request POST 'https://mvsep.com/api/app/enable_premium' --form 'api_token="<Az API-tokenje>"'
Kulcs | Érték |
---|---|
success |
|
message | Tájékoztat a művelet állapotáról |
Az MVSEP API a következő hibakódokat használja:
Hibakód | Jelentése |
---|---|
400 | Érvénytelen API kulcs |
A felhasználó prémiumhasználatának letiltásához POST-hívást kell indítanod a következő url-re:
https://mvsep.com/api/app/disable_premium
Terület | típus | Leírás |
---|---|---|
api_token | String | A felhasználó API kulcsa |
curl --location --request POST 'https://mvsep.com/api/app/disable_premium' --form 'api_token="<Az API-tokenje>"'
Kulcs | Érték |
---|---|
success |
|
message | Tájékoztat a művelet állapotáról |
Az MVSEP API a következő hibakódokat használja:
Hibakód | Jelentése |
---|---|
400 | Érvénytelen API kulcs |
Ahhoz, hogy engedélyezd a hosszú fájlneveket a felhasználó számára, egy POST hívást kell indítanod a következő url-re:
https://mvsep.com/api/app/enable_long_filenames
Terület | típus | Leírás |
---|---|---|
api_token | String | A felhasználó API kulcsa |
curl --location --request POST 'https://mvsep.com/api/app/enable_long_filenames' --form 'api_token="<Az API-tokenje>"'
Kulcs | Érték |
---|---|
success |
|
message | Tájékoztat a művelet állapotáról |
Az MVSEP API a következő hibakódokat használja:
Hibakód | Jelentése |
---|---|
400 | Érvénytelen API kulcs |
Ahhoz, hogy letiltsd a hosszú fájlneveket a felhasználó számára, egy POST hívást kell indítanod a következő url-re:
https://mvsep.com/api/app/disable_long_filenames
Terület | típus | Leírás |
---|---|---|
api_token | String | A felhasználó API kulcsa |
curl --location --request POST 'https://mvsep.com/api/app/disable_long_filenames' --form 'api_token="<Az API-tokenje>"'
Kulcs | Érték |
---|---|
success |
|
message | Tájékoztat a művelet állapotáról |
Az MVSEP API a következő hibakódokat használja:
Hibakód | Jelentése |
---|---|
400 | Érvénytelen API kulcs |
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
Terület | típus | Leírás |
---|---|---|
start | Integer | (opcionális) Kezdőpont eltolás, alapértelmezés szerint 0 (azaz a legkésőbbi kezdettől) |
limit | Integer | (nem kötelező) A visszaadott találatok maximális száma, alapértelmezés szerint 10, maximum 20. |
curl --location --request GET 'https://mvsep.com/api/quality_checker/queue?&start=1&limit=2'
Az adatokat tömbként adja vissza:
Kulcs | Érték |
---|---|
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
Terület | típus | Leírás |
---|---|---|
dataset_type | String | Dataset Type, defaults to 0 if not given
|
start | Integer | (opcionális) Kezdőpont eltolás, alapértelmezés szerint 0 (azaz a legkésőbbi kezdettől) |
limit | Integer | (nem kötelező) A visszaadott találatok maximális száma, alapértelmezés szerint 10, maximum 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'
Kulcs | Érték |
---|---|
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
Terület | típus | Leírás |
---|---|---|
api_token | String | (required) Az Ön API-kulcsa |
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"'
Kulcs | Érték |
---|---|
success |
|
data | Contains information about entry |
data -> id | ID of the entry. |
data -> link | Link to the entry. |
Az MVSEP API a következő hibakódokat használja:
Hibakód | Jelentése |
---|---|
400 | Az űrlap érvénytelen |
401 |
Ismeretlen vagy érvénytelen api_token . Ez a hiba akkor jelenik meg, ha ismeretlen API-kulcsot használ
|
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
Terület | típus | Leírás |
---|---|---|
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
Terület | típus | Leírás |
---|---|---|
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"'
Kulcs | Érték |
---|---|
success |
|
data->message | Shows whether entry was deleted |
turbo@mvsep.com