turbo@mvsep.com
MVSEP API tarjoaa ohjelmallisen pääsyn erottelun luomiseen, tulosten palauttamiseen, sivuston tietojen hakemiseen ja käyttäjän ominaisuuksien hallintaan.
API:n käyttöön tarvitset API-avaimen. Et ole kirjautunut sisään, kirjaudu sisään saadaksesi API-tunnuksesi.
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
Huomaa, että Premium-käyttäjät voivat pyytää jopa 10 samanaikaista tehtävää, kun taas ei-Premium-käyttäjät voivat pyytää vain yhden samanaikaisen tehtävän.
Erottamisen luomiseksi sinun tulee tehdä POST-kutsu seuraavaan URL-osoitteeseen:
https://mvsep.com/api/separation/create
| Kenttä | Tyyppi | Kuvaus |
|---|---|---|
| api_token | String | API-avaimesi |
| audiofile | Binary | Käsiteltävä äänitiedosto. 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 | (valinnainen) Erottelun tyyppi, oletusarvoisesti 11 (Demucs3 Model B (laulu, rummut, basso, muut)) |
| add_opt1 | String | (valinnainen) Erottelun tyypin ensimmäinen lisäkenttä |
| add_opt2 | String | (valinnainen) Erottelun tyypin toinen lisäkenttä |
| add_opt3 | String | (valinnainen) Erotustyypin kolmas lisäkenttä |
| output_format | Integer | (valinnainen) tulostusmuoto, oletusarvoisesti 0 (mp3 (320kbps)) |
| is_demo | Boolean | (valinnainen) julkaistaanko erottelu demo-sivulla, oletusarvoisesti false |
| Nimi | Arvo | 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 |
| Nimi | Arvo |
|---|---|
| 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="<API-tunnuksesi>"'
--form 'sep_type="9"'
--form 'add_opt1="0"'
--form 'add_opt2="1"'
--form 'output_format="1"'
--form 'is_demo="1"'
| Avain | Arvo |
|---|---|
| success |
|
| data | Sisältää lisätietoja success-näppäimestä riippuen |
| data -> link | Näyttää linkin luodun työn HAE TULOS -URL-osoitteeseen (näkyy vain, kun success on true) |
| data -> hash | Näyttää luodun työn hajautusarvon (näytetään vain, kun success on true) |
| data -> message | Näyttää virheen kuvauksen (näkyy vain, kun success on false) |
MVSEP API käyttää seuraavia virhekoodeja:
| Virhekoodi | Merkitsevä |
|---|---|
| 400 | Joitakin parametreja puuttuu tai ne ovat virheellisiä. Tämä virhe ilmenee, kun et välitä kaikkia pakollisia parametreja tai välität virheellisiä parametreja. |
| 401 |
Tuntematon tai epäkelpo api_token. Tämä virhe ilmenee, jos käytät tuntematonta API-avainta
|
Erottelun tuloksen saamiseksi sinun tulee tehdä GET-kutsu seuraavaan URL-osoitteeseen:
https://mvsep.com/api/separation/get
| Kenttä | Tyyppi | Kuvaus |
|---|---|---|
| hash | String | Erottelun Hash |
| mirror | Integer | (valinnainen) Käyttää toista peiliä, jos asetuksena on 1, oletusarvo on 0. Edellyttää api_token ja 1 opintopistettä, jos arvoksi on määritetty 1. |
| api_token | string | (valinnainen) käyttäjän API-avain. Pakollinen, jos peiliparametrin arvoksi on asetettu 1. |
curl --location --request GET 'https://mvsep.com/api/separation/get?hash=20230327071601-0e3e5c6c85-13-dimensions.mp3'
| Avain | Arvo |
|---|---|
| success |
|
| status |
|
| data | Sisältää lisätietoja status-näppäimestä riippuen |
| data -> queue_count | Näyttää käsittelemättömien töiden määrän käyttäjän prioriteetissa (näkyy vain, kun status on waiting tai distributing) |
| data -> current_order | Näyttää käyttäjän töiden järjestyksen (näkyy vain, kun status on waiting tai distributing) |
| data -> message | Näyttää tilan kuvauksen (näkyy kaikissa tiloissa, näyttää virheen syyn, kun status on failed) |
| data -> algorithm | Näyttää työssä käytetyn algoritmin (näkyy vain, kun status on |
| data -> algorithm_description | Näyttää käytetyn algoritmin tiedot työssä (näkyy vain, kun status on |
| data -> output_format | Näyttää työn tulostusmuodon (näkyy vain, kun status on done) |
| data -> tags | Näyttää äänen sisällönkuvauskentät (näytetään vain, kun tila on |
| data -> input_file | Näyttää äänen lataustiedot (näytetään vain, kun tila on |
| data -> files | Näyttää ulostulon lataustiedot (näkyy vain, kun status on done) |
| data -> date | Näyttää työn käsittelypäivämäärän (näkyy vain, kun status on done) |
| data -> finished_chunks | Näyttää suuren työn valmiiden osien määrän (näkyy vain, kun tila on |
| data -> all_chunks | Näyttää suuren työn kaikkien osien määrän (näkyy vain, kun status on distributing) |
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
| Kenttä | Tyyppi | Kuvaus |
|---|---|---|
| hash | String | Erottelun Hash |
curl --location --request GET 'https://mvsep.com/api/separation/get-remote?hash=n2AwBjy4KsFZfqqR'
| Avain | Arvo |
|---|---|
| success |
|
| status |
|
| data | Sisältää lisätietoja status-näppäimestä riippuen |
| 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
| Kenttä | Tyyppi | Kuvaus |
|---|---|---|
| api_token | string | Käyttäjän API-avain |
| hash | string | Erottelun Hash |
curl --location --request POST 'https://mvsep.com/api/separation/cancel' --form 'api_token="<API-tunnuksesi>"' --form 'hash="<hash>"'
| Avain | Arvo |
|---|---|
| success |
|
Jos haluat saada yksityiskohtaisia tietoja erottelutyypeistä, sinun on soitettava GET-puhelu seuraavaan URL-osoitteeseen:
https://mvsep.com/api/app/algorithms
curl --location --request GET 'https://mvsep.com/api/app/algorithms'
Palauttaa tiedot matriisina.:
| Avain | Arvo |
|---|---|
| render_id | Erotustyypin arvo (ID) |
| name | Erotustyypin nimi |
| algorithm_group_id |
Ryhmä, johon erottelutyyppi kuuluu:
|
| orientation |
Kenelle tämä erottelutyyppi on tarkoitettu:
|
| order_id | Erottelutyypin järjestys |
| price_coefficient |
Käytetään laskemaan, kuinka monta opintopistettä työ vie premium-käyttäjältä. Käyttää tätä kaavaa : floor(<äänitiedoston kesto sekunteina> * price_coefficient / 60)?:1
|
| usage | Shows monthly usage count of separation type |
| rating | Shows monthly usage rating of separation type as array:
|
| algorithm_fields | Sisältää tietoja erottelutyypin muista kentistä. |
| algorithm_fields -> name |
Näyttää, mikä erotustyypin lisäkenttä:
|
| algorithm_fields -> text | Erotustyypin lisäkentän näyttönimi. |
| algorithm_fields -> options | JSON Lisäkentän koodatut avainarvoketjut |
| algorithm_fields -> default_key | Lisäkentän oletusarvo. Yksi <koodin>algorithm_fields -> vaihtoehdoista< / koodi> |
| algorithm_descriptions | Sisältää tietoja erotustyypin kuvauksista |
| algorithm_descriptions -> short_description | Pieni kuvaus erotustyypistä, joka ei käytä HTML-koodia. |
| algorithm_descriptions -> long_description | HTML-koodia käyttävän erotustyypin yksityiskohtainen kuvaus. |
| algorithm_descriptions -> lang | Kuvauksen määritetty kielikoodi. |
Saadaksesi tietoa viimeisimmistä MVSEP-uutisista, sinun on soitettava GET-puhelu seuraavaan URL-osoitteeseen:
https://mvsep.com/api/app/news
| Kenttä | Tyyppi | Kuvaus |
|---|---|---|
| lang | String | (valinnainen) 2-kirjaiminen kielikoodi (en, ru) |
| start | Integer | (valinnainen) Lähtöpisteen siirtymä, oletusarvo 0 (eli alkaa uusimmasta) |
| limit | Integer | (valinnainen) Palautettujen tulosten enimmäismäärä, oletusarvo 10, maksimi on 20. |
curl --location --request GET 'https://mvsep.com/api/app/news?lang=en&start=2&limit=1'
Palauttaa tiedot matriisina.:
| Avain | Arvo |
|---|---|
| title | Uutisen otsikko |
| lang | Uutisen otsikko |
| text | Täydellinen kuvaus uutisista |
| created_at | Uutisen päivämäärä |
To get site queue information, you need to make a GET call to the following url:
https://mvsep.com/api/app/queue
| Kenttä | Tyyppi | Kuvaus |
|---|---|---|
| api_token | String | (optional) Käyttäjän API-avain |
curl --location --request GET 'https://mvsep.com/api/app/queue'
| Avain | Arvo |
|---|---|
| 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):
|
Jos haluat saada tietoja esittelyeroista, sinun on soitettava GET-puhelu seuraavaan URL-osoitteeseen:
https://mvsep.com/api/app/demo
| Kenttä | Tyyppi | Kuvaus |
|---|---|---|
| start | Integer | (valinnainen) Lähtöpisteen siirtymä, oletusarvo 0 (eli alkaa uusimmasta) |
| limit | Integer | (valinnainen) Palautettujen tulosten enimmäismäärä, oletusarvo 10, maksimi on 20. |
curl --location --request GET 'https://mvsep.com/api/app/demo?start=0&limit=2'
Palauttaa tiedot matriisina.:
| Avain | Arvo |
|---|---|
| hash | Erottelun Hash |
| date | Eron päivämäärä |
| input_audio | Syötä äänen URL-osoite |
| size | Tulon äänen koko |
| algorithm | Sisältää perustietoja käytetystä erottelutyypistä (katso lisätietoja palautetuista parametreista kohdasta HAE EROTTELUTYYPIT) |
Jos haluat todentaa käyttäjän ja saada käyttäjän API-avaimen, sinun on soitettava POST-puhelu seuraavaan URL-osoitteeseen:
https://mvsep.com/api/app/login
| Kenttä | Tyyppi | Kuvaus |
|---|---|---|
| String | Käyttäjän sähköpostiosoite | |
| password | String | Käyttäjän salasana |
curl --location --request POST 'https://mvsep.com/api/app/login' --form 'email="<Käyttäjän sähköpostiosoite>"' --form 'password="<Käyttäjän salasana>"'
| Avain | Arvo |
|---|---|
| success |
|
| data | Sisältää tiedot, kun tunnistetiedot ovat kelvollisia |
| data -> name | Käyttäjän nimi |
| data -> email | Käyttäjän sähköpostiosoite |
| data -> api_token | Käyttäjän API-avain. Varmista, että säilytät sitä turvallisessa säilytyksessä ja käytät sitä seuraavia toimintoja varten. |
| data -> premium_minutes | Käyttäjälle jäävät krediitit |
| data -> premium_enabled |
Salliko käyttäjä krediittien käyttämisen.
|
| data -> long_filenames_enabled |
Haluaako käyttäjä lisätietoja tiedostonimissä:
|
MVSEP API käyttää seuraavia virhekoodeja:
| Virhekoodi | Merkitsevä |
|---|---|
| 400 | Virheelliset tunnistetiedot määritetty |
Jos haluat rekisteröidä käyttäjän MVSEP-sivustoon, sinun on soitettava POST-puhelu seuraavaan URL-osoitteeseen:
https://mvsep.com/api/app/register
| Kenttä | Tyyppi | Kuvaus |
|---|---|---|
| name | String | Käyttäjän nimi |
| String | Käyttäjän sähköpostiosoite | |
| password | String | Käyttäjän salasana |
| password_confirmation | String | Toista käyttäjän salasana |
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"'
| Avain | Arvo |
|---|---|
| success |
|
| message | Tapahtuu, kun lomake on kelvollinen |
MVSEP API käyttää seuraavia virhekoodeja:
| Virhekoodi | Merkitsevä |
|---|---|
| 400 | Lomake on virheellinen |
Jotta saat käyttäjätietoja, sinun on soitettava GET-puhelu seuraavaan URL-osoitteeseen:
https://mvsep.com/api/app/user
| Kenttä | Tyyppi | Kuvaus |
|---|---|---|
| api_token | String | Käyttäjän API-avain |
curl --location --request GET 'https://mvsep.com/api/app/user?api_token=<API-tunnuksesi>'
| Avain | Arvo |
|---|---|
| success |
|
| data | Sisältää tiedot, kun tunnistetiedot ovat kelvollisia |
| data -> name | Käyttäjän nimi |
| data -> email | Käyttäjän sähköpostiosoite |
| data -> api_token | Käyttäjän API-avain. Varmista, että säilytät sitä turvallisessa säilytyksessä ja käytät sitä seuraavia toimintoja varten. |
| data -> premium_minutes | Käyttäjälle jäävät krediitit |
| data -> premium_enabled |
Salliko käyttäjä krediittien käyttämisen.
|
| data -> long_filenames_enabled |
Haluaako käyttäjä lisätietoja tiedostonimissä:
|
| data -> current_queue | Näyttää käyttäjän jatkuvat erottelut |
MVSEP API käyttää seuraavia virhekoodeja:
| Virhekoodi | Merkitsevä |
|---|---|
| 400 | Virheellinen API-avain |
Jos haluat saada käyttäjän perustietojen erotteluhistorian, sinun on soitettava GET-puhelu seuraavaan URL-osoitteeseen:
https://mvsep.com/api/app/separation_history
| Kenttä | Tyyppi | Kuvaus |
|---|---|---|
| api_token | String | Käyttäjän API-avain |
| start | Integer | (valinnainen) Lähtöpisteen siirtymä, oletusarvo 0 (eli alkaa uusimmasta) |
| limit | Integer | (valinnainen) Palautettujen tulosten enimmäismäärä, oletusarvo 10, maksimi on 20. |
curl --location --request GET 'https://mvsep.com/api/app/separation_history?api_token=<API-tunnuksesi>&start=1&limit=2'
| Avain | Arvo |
|---|---|
| success |
|
| data | Sisältää perustietotaulukon aiemmista eroista |
| data -> hash | Erottelun Hash |
| data -> job_exists | Sisältää perustietotaulukon aiemmista eroista |
| data -> credits | Kuinka monta opintopistettä työhön käytettiin, null, jos erottelua ei ole |
| data -> time_left | Arvioitu aika, joka on jäljellä työn poistamiseen |
| data -> algorithm | Sisältää perustietoja käytetystä erottelutyypistä (katso lisätietoja palautetuista parametreista kohdasta HAE EROTTELUTYYPIT) |
MVSEP API käyttää seuraavia virhekoodeja:
| Virhekoodi | Merkitsevä |
|---|---|
| 400 | Virheellinen API-avain |
Jos haluat ottaa premium-käytön käyttöön käyttäjälle, sinun on soitettava POST-puhelu seuraavaan URL-osoitteeseen:
https://mvsep.com/api/app/enable_premium
| Kenttä | Tyyppi | Kuvaus |
|---|---|---|
| api_token | String | Käyttäjän API-avain |
curl --location --request POST 'https://mvsep.com/api/app/enable_premium' --form 'api_token="<API-tunnuksesi>"'
| Avain | Arvo |
|---|---|
| success |
|
| message | Tiedottaa toiminnan tilasta |
MVSEP API käyttää seuraavia virhekoodeja:
| Virhekoodi | Merkitsevä |
|---|---|
| 400 | Virheellinen API-avain |
Jos haluat poistaa premium-käytön käytöstä käyttäjältä, sinun on soitettava POST-puhelu seuraavaan URL-osoitteeseen:
https://mvsep.com/api/app/disable_premium
| Kenttä | Tyyppi | Kuvaus |
|---|---|---|
| api_token | String | Käyttäjän API-avain |
curl --location --request POST 'https://mvsep.com/api/app/disable_premium' --form 'api_token="<API-tunnuksesi>"'
| Avain | Arvo |
|---|---|
| success |
|
| message | Tiedottaa toiminnan tilasta |
MVSEP API käyttää seuraavia virhekoodeja:
| Virhekoodi | Merkitsevä |
|---|---|
| 400 | Virheellinen API-avain |
Jos haluat ottaa käyttäjälle käyttöön pitkät tiedostonimet, sinun on soitettava POST-puhelu seuraavaan URL-osoitteeseen:
https://mvsep.com/api/app/enable_long_filenames
| Kenttä | Tyyppi | Kuvaus |
|---|---|---|
| api_token | String | Käyttäjän API-avain |
curl --location --request POST 'https://mvsep.com/api/app/enable_long_filenames' --form 'api_token="<API-tunnuksesi>"'
| Avain | Arvo |
|---|---|
| success |
|
| message | Tiedottaa toiminnan tilasta |
MVSEP API käyttää seuraavia virhekoodeja:
| Virhekoodi | Merkitsevä |
|---|---|
| 400 | Virheellinen API-avain |
Jos haluat poistaa pitkät tiedostonimet käytöstä käyttäjältä, sinun on soitettava POST-puhelu seuraavaan URL-osoitteeseen:
https://mvsep.com/api/app/disable_long_filenames
| Kenttä | Tyyppi | Kuvaus |
|---|---|---|
| api_token | String | Käyttäjän API-avain |
curl --location --request POST 'https://mvsep.com/api/app/disable_long_filenames' --form 'api_token="<API-tunnuksesi>"'
| Avain | Arvo |
|---|---|
| success |
|
| message | Tiedottaa toiminnan tilasta |
MVSEP API käyttää seuraavia virhekoodeja:
| Virhekoodi | Merkitsevä |
|---|---|
| 400 | Virheellinen API-avain |
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
| Kenttä | Tyyppi | Kuvaus |
|---|---|---|
| start | Integer | (valinnainen) Lähtöpisteen siirtymä, oletusarvo 0 (eli alkaa uusimmasta) |
| limit | Integer | (valinnainen) Palautettujen tulosten enimmäismäärä, oletusarvo 10, maksimi on 20. |
curl --location --request GET 'https://mvsep.com/api/quality_checker/queue?&start=1&limit=2'
Palauttaa tiedot matriisina.:
| Avain | Arvo |
|---|---|
| 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
| Kenttä | Tyyppi | Kuvaus |
|---|---|---|
| dataset_type | String | Dataset Type, defaults to 0 if not given
|
| start | Integer | (valinnainen) Lähtöpisteen siirtymä, oletusarvo 0 (eli alkaa uusimmasta) |
| limit | Integer | (valinnainen) Palautettujen tulosten enimmäismäärä, oletusarvo 10, maksimi on 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'
| Avain | Arvo |
|---|---|
| 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
| Kenttä | Tyyppi | Kuvaus |
|---|---|---|
| api_token | String | (required) API-avaimesi |
| 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"'
| Avain | Arvo |
|---|---|
| success |
|
| data | Contains information about entry |
| data -> id | ID of the entry. |
| data -> link | Link to the entry. |
MVSEP API käyttää seuraavia virhekoodeja:
| Virhekoodi | Merkitsevä |
|---|---|
| 400 | Lomake on virheellinen |
| 401 |
Tuntematon tai epäkelpo api_token. Tämä virhe ilmenee, jos käytät tuntematonta API-avainta
|
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
| Kenttä | Tyyppi | Kuvaus |
|---|---|---|
| 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
| Kenttä | Tyyppi | Kuvaus |
|---|---|---|
| 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"'
| Avain | Arvo |
|---|---|
| success |
|
| data->message | Shows whether entry was deleted |
turbo@mvsep.com