API-ul MVSEP oferă acces programatic pentru a crea o separare, a returna rezultatele, a obține informații despre site și a controla capacitățile utilizatorului.
Pentru a folosi acest API, ai nevoie de o cheie API. Nu sunteți conectat, vă rugăm să vă conectați pentru a obține tokenul API.
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
OpenAPI Specification: mvsep-openapi-spec.json
Note that Premium users can request unlimited concurrent jobs, while non-Premium users can only request 1 concurrent job.
Pentru a crea o sarcină de separare, trebuie să faci un call POST către următorul URL:
https://mvsep.com/api/separation/create
| Câmp | Tip | Descriere |
|---|---|---|
| api_token | String | Cheia ta API |
| audiofile | Binary | Fișier audio spre separare. Not required if url parameter is set or model do not use file input. For matchering models use target_audiofile and reference_audiofile for input instead of audiofile. |
| 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 | (opțional) Tip separare, implicit 11 (Demucs3 Model B (vocals, drums, bass, other) |
| add_opt1 | String | (opțional) Tip separare primul câmp adițional |
| add_opt2 | String | (opțional) Tip separare câmp adițional secundar |
| add_opt3 | String | (opțional) Tip separare al treilea câmp suplimentar |
| output_format | Integer | (opțional) format de ieșire, implicit 0 (mp3 (320kbps)) |
| is_demo | Boolean | (opțional) varianta separată trebuie să fie postată pe pagina demo-urilor, implicit fals |
| Nume | Valoare | 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 | |
| Demucs4 HT (vocals, drums, bass, other) | 20 | Key: add_opt1 Name: Model type Options:
|
| 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:
|
| 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 | |
| MVSep 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 Crowd removal (crowd, other) | 34 | 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:
|
| MVSep Choir (choir, other) | 112 | Key: add_opt2 Name: How to extract Options:
|
| MVSep SATB Choir (soprano, alto, tenor, bass) | 111 | Key: add_opt1 Name: Model type Options:
Key: add_opt2 Name: How to extract 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 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 Synth (synth, other) | 88 | Key: add_opt1 Name: How to extract 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:
|
| MVSep Piano (piano, other) | 29 | Key: add_opt1 Name: Piano model type Options:
|
| MVSep Digital Piano (digital-piano, other) | 79 | Key: add_opt2 Name: How to extract Options:
|
| MVSep Keys (keys, other) | 106 | |
| MVSep Organ (organ, other) | 58 | Key: add_opt1 Name: Organ model type Options:
|
| MVSep Harpsichord (harpsichord, other) | 91 | |
| MVSep Accordion (accordion, other) | 99 | |
| MVSep Guitar (guitar, other) | 31 | Key: add_opt1 Name: Guitar model type Options:
|
| MVSep Acoustic Guitar (acoustic-guitar, other) | 66 | Key: add_opt2 Name: How to extract Options:
|
| MVSep Electric Guitar (electric-guitar, other) | 81 | Key: add_opt2 Name: How to extract Options:
|
| MVSep Lead/Rhythm Guitar (lead-guitar, rhythm-guitar) | 101 | Key: add_opt1 Name: Model type Options:
|
| MVSep Plucked Strings (plucked-strings, other) | 102 | |
| MVSep Harp (harp, other) | 72 | |
| MVSep Mandolin (mandolin, other) | 74 | |
| MVSep Banjo (banjo, other) | 83 | |
| MVSep Sitar (sitar, other) | 90 | |
| MVSep Ukulele (ukulele, other) | 96 | |
| MVSep Dobro (dobro, other) | 97 | |
| MVSep Bowed Strings (strings, other) | 52 | Key: add_opt1 Name: String model type Options:
Key: add_opt2 Name: How to extract Options:
|
| MVSep Violin (violin, other) | 65 | |
| MVSep Viola (viola, other) | 69 | Key: add_opt2 Name: How to extract Options:
|
| MVSep Cello (cello, other) | 70 | Key: add_opt2 Name: How to extract Options:
|
| MVSep Double Bass (double-bass, other) | 73 | Key: add_opt2 Name: How to extract Options:
|
| 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 Brass (brass, other) | 107 | Key: add_opt1 Name: How to extract Options:
|
| MVSep Woodwind (woodwind, other) | 108 | Key: add_opt1 Name: How to extract Options:
|
| MVSep Saxophone (saxophone, other) | 61 | Key: add_opt1 Name: Model type Options:
|
| MVSep Flute (flute, other) | 67 | Key: add_opt1 Name: Flute model type Options:
Key: add_opt2 Name: How to extract Options:
|
| MVSep Trumpet (trumpet, other) | 71 | Key: add_opt2 Name: How to extract Options:
|
| MVSep Trombone (trombone, other) | 75 | Key: add_opt2 Name: How to extract Options:
|
| MVSep Oboe (oboe, other) | 77 | Key: add_opt2 Name: How to extract Options:
|
| MVSep Clarinet (clarinet, other) | 78 | Key: add_opt2 Name: How to extract Options:
|
| MVSep French Horn (french-horn, other) | 82 | Key: add_opt2 Name: How to extract Options:
|
| MVSep Harmonica (harmonica, other) | 87 | Key: add_opt2 Name: How to extract Options:
|
| MVSep Tuba (tuba, other) | 92 | |
| MVSep Bassoon (bassoon, other) | 93 | |
| MVSep Bagpipes (bagpipes , other) | 116 | Key: add_opt2 Name: How to extract Options:
|
| MVSep Percussion (percussion, other) | 105 | |
| MVSep Tambourine (tambourine, other) | 76 | |
| MVSep Marimba (marimba, other) | 84 | |
| MVSep Glockenspiel (glockenspiel, other) | 85 | |
| MVSep Timpani (timpani, other) | 86 | |
| MVSep Triangle (triangle, other) | 89 | |
| MVSep Congas (congas , other) | 94 | |
| MVSep Bells (bells, other) | 95 | |
| MVSep Wind Chimes (wind-chimes, other) | 98 | |
| MVSep Xylophone (xylophone, other) | 109 | Key: add_opt2 Name: How to extract Options:
|
| MVSep Celesta (celesta, other) | 110 | Key: add_opt2 Name: How to extract Options:
|
| MVSep Demucs4HT DNR (speech, music, effects) | 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, effects) | 56 | Key: add_opt1 Name: Model type Options:
Key: add_opt2 Name: How to extract Options:
Key: add_opt3 Name: Output files Options:
|
| MVSep Braam (braam , other) | 117 | |
| Apollo Enhancers (by JusperLee, Lew, baicai1145) | 51 | Key: add_opt1 Name: Model type Options:
Key: add_opt2 Name: Cutoff (Hz) Options:
|
| Reverb Removal (noreverb) | 22 | Key: add_opt1 Name: Model Type Options:
Key: add_opt2 Name: Preprocess Options:
|
| DeNoise by aufr33 | 47 | Key: add_opt1 Name: Model type Options:
|
| AudioSR (Super Resolution) | 59 | Key: add_opt1 Name: Cutoff (Hz) Options:
|
| FlashSR (Super Resolution) | 60 | |
| Stable Audio Open Gen | 62 | Key: add_opt1 Name: Text prompt Options: Key: add_opt2 Name: Length (in seconds) 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:
Key: add_opt2 Name: Version Options:
|
| VibeVoice (Voice Cloning) | 103 | Key: add_opt1 Name: Model type Options:
Key: add_opt2 Name: Text prompt Options: Key: add_opt3 Name: Extract vocals first Options:
|
| VibeVoice (TTS) | 104 | Key: add_opt1 Name: Model type Options:
Key: add_opt2 Name: Text prompt Options: |
| Qwen3-TTS (Custom Voice) | 118 | Key: add_opt1 Name: Text prompt Options: Key: add_opt2 Name: Speaker Options:
Key: add_opt3 Name: Language Options:
Key: add_opt4 Name: Voice description Options: |
| Qwen3-TTS (Voice Design) | 119 | Key: add_opt1 Name: Text prompt Options: Key: add_opt2 Name: Voice description Options: Key: add_opt3 Name: Language Options:
|
| Qwen3-TTS (Voice Cloning) | 120 | Key: add_opt1 Name: Text prompt Options: Key: add_opt2 Name: Reference text in audio (optional) Options: Key: add_opt3 Name: Language Options:
Key: add_opt4 Name: Extract vocals first Options:
|
| Bark (Speech Gen) | 115 | Key: add_opt1 Name: Text prompt Options: Key: add_opt2 Name: Speaker Options:
|
| MVSep MultiSpeaker (MDX23C) | 42 | Key: add_opt1 Name: Model Type Options:
|
| Aspiration (by Sucial) | 50 | Key: add_opt1 Name: Model type Options:
|
| Phantom Centre extraction (by wesleyr36) | 55 | |
| Matchering (by sergree) | 68 | |
| SOME (Singing-Oriented MIDI Extractor) | 80 | Key: add_opt1 Name: How to use Options:
|
| Transkun (piano -> midi) | 113 | Key: add_opt1 Name: How to extract Options:
|
| Basic Pitch (MIDI Extraction) | 114 | |
| Demucs3 Model (vocals, drums, bass, other) | 10 | Key: add_opt1 Name: Model type Options:
|
| MDX A/B (vocals, drums, bass, other) | 7 | Key: add_opt1 Name: Vocal 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 Old 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:
|
| Nume | Valoare |
|---|---|
| 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="<Tokenul tău API>"'
--form 'sep_type="9"'
--form 'add_opt1="0"'
--form 'add_opt2="1"'
--form 'output_format="1"'
--form 'is_demo="1"'
| Cheie | Valoare |
|---|---|
| success |
|
| data | Deține informații suplimentare în funcție de tasta success |
| data -> link | Afișează linkul către URL-ul "GET RESULT" al lucrării create (afișat numai atunci când success este true) |
| data -> hash | Afișează hash-ul lucrării create (afișat numai atunci când success este true) |
| data -> message | Afișează descrierea unei erori (afișată numai atunci când success este |
API-ul MVSEP folosește următoarele coduri de eroare:
| Cod de Eroare | Înseamnă |
|---|---|
| 400 | Anumiți parametri lipsesc sau nu sunt valabili. Această eroare apare atunci când nu treci toți parametrii obligatorii sau treci parametri nevalabili. |
| 401 |
Unknown or unvalid api_token. Această eroare apare dacă folosești o cheie API incorectă
|
Pentru a primi rezultatul separării, trebuie să faci un call POST către următorul URL:
https://mvsep.com/api/separation/get
| Câmp | Tip | Descriere |
|---|---|---|
| hash | String | Hash separare |
| mirror | Integer | (opțional) Folosește o altă oglindă dacă este setată la 1, implicit la 0. Necesită api_token și 1 credit dacă este setat la 1. |
| api_token | string | cheie API (opțională) a utilizatorului. Obligatoriu dacă parametrul oglindă este setat la 1. |
curl --location --request GET 'https://mvsep.com/api/separation/get?hash=20230327071601-0e3e5c6c85-13-dimensions.mp3'
| Cheie | Valoare |
|---|---|
| success |
|
| status |
|
| data | Conține informații suplimentare în funcție de tasta status |
| data -> queue_count | Afișează numărul de lucrări neprocesate în prioritatea utilizatorului (afișat numai atunci când status este |
| data -> current_order | Afișează ordinea lucrării utilizatorului (afișată numai atunci când status este |
| data -> message | Afișează descrierea stării (afișată pe toate stările, afișează motivul erorii în schimb atunci când status este |
| data -> algorithm | Afișează algoritmul utilizat la locul de muncă (afișat numai atunci când status este |
| data -> algorithm_description | Afișează detaliile algoritmului utilizat pe loc de muncă (afișat numai atunci când status este |
| data -> output_format | Afișează formatul de ieșire al lucrării (afișat numai atunci când status este |
| data -> tags | Afișează metaetichetele audio (afișate numai atunci când status este |
| data -> input_file | Afișează detaliile de descărcare audio de intrare (afișate numai atunci când status este |
| data -> files | Afișează detaliile de descărcare a sunetelor de ieșire (afișate numai atunci când status este |
| data -> date | Afișează data procesării lucrării (afișată numai atunci când status este |
| data -> finished_chunks | Afișează numărul de piese finalizate ale unei lucrări mari (afișat numai atunci când status este |
| data -> all_chunks | Afișează numărul tuturor părților unei lucrări mari (afișat numai atunci când status este |
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
| Câmp | Tip | Descriere |
|---|---|---|
| hash | String | Hash separare |
curl --location --request GET 'https://mvsep.com/api/separation/get-remote?hash=n2AwBjy4KsFZfqqR'
| Cheie | Valoare |
|---|---|
| success |
|
| status |
|
| data | Conține informații suplimentare în funcție de tasta status |
| 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
| Câmp | Tip | Descriere |
|---|---|---|
| api_token | string | Cheia API a utilizatorului |
| hash | string | Hash separare |
curl --location --request POST 'https://mvsep.com/api/separation/cancel' --form 'api_token="<Tokenul tău API>"' --form 'hash="<hash>"'
| Cheie | Valoare |
|---|---|
| success |
|
Pentru a obține date detaliate despre tipurile de separare, trebuie să efectuați un apel GET la următoarea adresă URL:
https://mvsep.com/api/app/algorithms
| Câmp | Tip | Descriere |
|---|---|---|
| scopes | String | Whether to include models that use different form of input.
single_upload if not provided. To get all models, set scopes=single_upload,no_upload,matchering_upload
|
curl --location --request GET 'https://mvsep.com/api/app/algorithms'
Returnează datele ca matrice:
| Cheie | Valoare |
|---|---|
| render_id | Valoarea tipului de separare (ID) |
| name | Numele tipului de separare |
| algorithm_group_id | Grupul în care aparține tipul de separare: |
| algorithm_group | Contains information about the algorithm group that the algorithm belongs to. |
| algorithm_group -> name | Name of the algorithm group. |
| audio_widget |
The type of audio widget to use for the algorithm. This can be used to determine how to display the audio player for the algorithm on the frontend. Possible values are:
|
| orientation |
Pentru cine se destinează acest tip de separare:
|
| order_id | Ordinea tipului de separare |
| price_coefficient |
Folosit pentru a calcula câte credite ia munca de la utilizatorul premium. Folosește această formulă : floor(<durata fișierului audio în secunde> * price_coefficient / 60)?:1
|
| usage | Shows monthly usage count of separation type |
| rating | Shows monthly usage rating of separation type as array:
|
| algorithm_fields | Conține informații despre câmpurile suplimentare de tip separare |
| algorithm_fields -> name |
Arată ce câmp suplimentar de tip separare:
|
| algorithm_fields -> text | Numele afișat al câmpului suplimentar al tipului de separare. |
| algorithm_fields -> options | JSON Lanțuri cheie-valoare codificate de câmp suplimentar |
| algorithm_fields -> default_key | Valoarea implicită a câmpului suplimentar. Una dintre cheile <code>algorithm_fields -> options</code> |
| algorithm_descriptions | Conține informații despre descrierile tipului de separare |
| algorithm_descriptions -> short_description | Descriere mică a tipului de separare care nu utilizează HTML. |
| algorithm_descriptions -> long_description | Descriere detaliată a tipului de separare care utilizează HTML. |
| algorithm_descriptions -> lang | Codul de limbă specificat al descrierii. |
Pentru a obține informații despre cele mai recente știri despre MVSEP, trebuie să efectuați un apel GET la următoarea adresă URL:
https://mvsep.com/api/app/news
| Câmp | Tip | Descriere |
|---|---|---|
| lang | String | (opțional) cod de limbă din 2 litere (en, ru) |
| start | Integer | (opțional) Decalaj punct de plecare, implicit la 0 (adică începe de la cel mai recent) |
| limit | Integer | (opțional) Numărul maxim de rezultate returnate, implicit la 10, maximul este 20. |
curl --location --request GET 'https://mvsep.com/api/app/news?lang=en&start=2&limit=1'
Returnează datele ca matrice:
| Cheie | Valoare |
|---|---|
| title | Titlul știrii |
| lang | Titlul știrii |
| text | Descrierea completă a știrilor |
| created_at | Data știrii |
To get site queue information, you need to make a GET call to the following url:
https://mvsep.com/api/app/queue
| Câmp | Tip | Descriere |
|---|---|---|
| api_token | String | (optional) Cheia API a utilizatorului |
curl --location --request GET 'https://mvsep.com/api/app/queue'
| Cheie | Valoare |
|---|---|
| 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):
|
Pentru a obține informații despre separările demonstrative, trebuie să efectuați un apel GET la următoarea adresă URL:
https://mvsep.com/api/app/demo
| Câmp | Tip | Descriere |
|---|---|---|
| start | Integer | (opțional) Decalaj punct de plecare, implicit la 0 (adică începe de la cel mai recent) |
| limit | Integer | (opțional) Numărul maxim de rezultate returnate, implicit la 10, maximul este 20. |
curl --location --request GET 'https://mvsep.com/api/app/demo?start=0&limit=2'
Returnează datele ca matrice:
| Cheie | Valoare |
|---|---|
| hash | Hash separare |
| date | Data separării |
| input_audio | URL audio de intrare |
| size | Dimensiunea audio de intrare |
| algorithm | Conține informații de bază despre tipul de separare utilizat (consultați fila GET SEPARATION TYPES pentru informații despre parametrii returnați) |
Pentru a autentifica utilizatorul și a obține cheia API a utilizatorului, trebuie să efectuați un apel POST la următoarea adresă URL:
https://mvsep.com/api/app/login
| Câmp | Tip | Descriere |
|---|---|---|
| String | E-mailul utilizatorului | |
| password | String | Parola utilizatorului |
curl --location --request POST 'https://mvsep.com/api/app/login' --form 'email="<E-mailul utilizatorului>"' --form 'password="<Parola utilizatorului>"'
| Cheie | Valoare |
|---|---|
| success |
|
| data | Conține informații când acreditările sunt valide |
| data -> name | Numele utilizatorului |
| data -> email | E-mailul utilizatorului |
| data -> api_token | Cheia API a utilizatorului. Asigurați-vă că îl depozitați într-un depozit securizat și utilizați-l pentru operațiuni ulterioare. |
| data -> premium_minutes | Credite rămase pentru utilizator |
| data -> premium_enabled |
Dacă utilizatorul a permis cheltuirea creditelor.
|
| data -> long_filenames_enabled |
Dacă utilizatorul dorește informații suplimentare în numele fișierelor:
|
API-ul MVSEP folosește următoarele coduri de eroare:
| Cod de Eroare | Înseamnă |
|---|---|
| 400 | Acreditări incorecte specificate |
Pentru a înregistra utilizatorul pe site-ul MVSEP, trebuie să efectuați un apel POST la următoarea adresă URL:
https://mvsep.com/api/app/register
| Câmp | Tip | Descriere |
|---|---|---|
| name | String | Numele utilizatorului |
| String | E-mailul utilizatorului | |
| password | String | Parola utilizatorului |
| password_confirmation | String | Repetați parola utilizatorului |
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"'
| Cheie | Valoare |
|---|---|
| success |
|
| message | Apare atunci când formularul este valid |
API-ul MVSEP folosește următoarele coduri de eroare:
| Cod de Eroare | Înseamnă |
|---|---|
| 400 | Formularul nu este valid |
Pentru a obține informații despre utilizator, trebuie să efectuați un apel GET la următoarea adresă URL:
https://mvsep.com/api/app/user
| Câmp | Tip | Descriere |
|---|---|---|
| api_token | String | Cheia API a utilizatorului |
curl --location --request GET 'https://mvsep.com/api/app/user?api_token=<Tokenul tău API>'
| Cheie | Valoare |
|---|---|
| success |
|
| data | Conține informații când acreditările sunt valide |
| data -> name | Numele utilizatorului |
| data -> email | E-mailul utilizatorului |
| data -> api_token | Cheia API a utilizatorului. Asigurați-vă că îl depozitați într-un depozit securizat și utilizați-l pentru operațiuni ulterioare. |
| data -> premium_minutes | Credite rămase pentru utilizator |
| data -> premium_enabled |
Dacă utilizatorul a permis cheltuirea creditelor.
|
| data -> long_filenames_enabled |
Dacă utilizatorul dorește informații suplimentare în numele fișierelor:
|
| data -> current_queue | Afișează separările în curs de desfășurare pentru utilizator |
API-ul MVSEP folosește următoarele coduri de eroare:
| Cod de Eroare | Înseamnă |
|---|---|
| 400 | Cheie API nevalidă |
Pentru a obține istoricul de separare a informațiilor de bază ale utilizatorului, trebuie să efectuați un apel GET la următoarea adresă URL:
https://mvsep.com/api/app/separation_history
| Câmp | Tip | Descriere |
|---|---|---|
| api_token | String | Cheia API a utilizatorului |
| start | Integer | (opțional) Decalaj punct de plecare, implicit la 0 (adică începe de la cel mai recent) |
| limit | Integer | (opțional) Numărul maxim de rezultate returnate, implicit la 10, maximul este 20. |
curl --location --request GET 'https://mvsep.com/api/app/separation_history?api_token=<Tokenul tău API>&start=1&limit=2'
| Cheie | Valoare |
|---|---|
| success |
|
| data | Conține informații de bază despre separările anterioare |
| data -> hash | Hash separare |
| data -> job_exists | Conține informații de bază despre separările anterioare |
| data -> credits | Câte credite au fost folosite pentru lucrare, nule dacă nu există separare |
| data -> time_left | Timp aproximativ rămas până la ștergerea lucrării |
| data -> algorithm | Conține informații de bază despre tipul de separare utilizat (consultați fila GET SEPARATION TYPES pentru informații despre parametrii returnați) |
API-ul MVSEP folosește următoarele coduri de eroare:
| Cod de Eroare | Înseamnă |
|---|---|
| 400 | Cheie API nevalidă |
Pentru a activa utilizarea premium pentru utilizator, trebuie să efectuați un apel POST la următoarea adresă URL:
https://mvsep.com/api/app/enable_premium
| Câmp | Tip | Descriere |
|---|---|---|
| api_token | String | Cheia API a utilizatorului |
curl --location --request POST 'https://mvsep.com/api/app/enable_premium' --form 'api_token="<Tokenul tău API>"'
| Cheie | Valoare |
|---|---|
| success |
|
| message | Informează despre stadiul operațiunii |
API-ul MVSEP folosește următoarele coduri de eroare:
| Cod de Eroare | Înseamnă |
|---|---|
| 400 | Cheie API nevalidă |
Pentru a dezactiva utilizarea premium pentru utilizator, trebuie să efectuați un apel POST la următoarea adresă URL:
https://mvsep.com/api/app/disable_premium
| Câmp | Tip | Descriere |
|---|---|---|
| api_token | String | Cheia API a utilizatorului |
curl --location --request POST 'https://mvsep.com/api/app/disable_premium' --form 'api_token="<Tokenul tău API>"'
| Cheie | Valoare |
|---|---|
| success |
|
| message | Informează despre stadiul operațiunii |
API-ul MVSEP folosește următoarele coduri de eroare:
| Cod de Eroare | Înseamnă |
|---|---|
| 400 | Cheie API nevalidă |
Pentru a activa numele de fișiere lungi pentru utilizator, trebuie să efectuați un apel POST la următoarea adresă URL:
https://mvsep.com/api/app/enable_long_filenames
| Câmp | Tip | Descriere |
|---|---|---|
| api_token | String | Cheia API a utilizatorului |
curl --location --request POST 'https://mvsep.com/api/app/enable_long_filenames' --form 'api_token="<Tokenul tău API>"'
| Cheie | Valoare |
|---|---|
| success |
|
| message | Informează despre stadiul operațiunii |
API-ul MVSEP folosește următoarele coduri de eroare:
| Cod de Eroare | Înseamnă |
|---|---|
| 400 | Cheie API nevalidă |
Pentru a dezactiva numele de fișiere lungi pentru utilizator, trebuie să efectuați un apel POST la următoarea adresă URL:
https://mvsep.com/api/app/disable_long_filenames
| Câmp | Tip | Descriere |
|---|---|---|
| api_token | String | Cheia API a utilizatorului |
curl --location --request POST 'https://mvsep.com/api/app/disable_long_filenames' --form 'api_token="<Tokenul tău API>"'
| Cheie | Valoare |
|---|---|
| success |
|
| message | Informează despre stadiul operațiunii |
API-ul MVSEP folosește următoarele coduri de eroare:
| Cod de Eroare | Înseamnă |
|---|---|
| 400 | Cheie API nevalidă |
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
| Câmp | Tip | Descriere |
|---|---|---|
| start | Integer | (opțional) Decalaj punct de plecare, implicit la 0 (adică începe de la cel mai recent) |
| limit | Integer | (opțional) Numărul maxim de rezultate returnate, implicit la 10, maximul este 20. |
curl --location --request GET 'https://mvsep.com/api/quality_checker/queue?&start=1&limit=2'
Returnează datele ca matrice:
| Cheie | Valoare |
|---|---|
| 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
| Câmp | Tip | Descriere |
|---|---|---|
| dataset_type | String | Dataset Type, defaults to 0 if not given
|
| start | Integer | (opțional) Decalaj punct de plecare, implicit la 0 (adică începe de la cel mai recent) |
| limit | Integer | (opțional) Numărul maxim de rezultate returnate, implicit la 10, maximul este 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'
| Cheie | Valoare |
|---|---|
| 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
| Câmp | Tip | Descriere |
|---|---|---|
| api_token | String | (required) Cheia ta API |
| 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"'
| Cheie | Valoare |
|---|---|
| success |
|
| data | Contains information about entry |
| data -> id | ID of the entry. |
| data -> link | Link to the entry. |
API-ul MVSEP folosește următoarele coduri de eroare:
| Cod de Eroare | Înseamnă |
|---|---|
| 400 | Formularul nu este valid |
| 401 |
Unknown or unvalid api_token. Această eroare apare dacă folosești o cheie API incorectă
|
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
| Câmp | Tip | Descriere |
|---|---|---|
| 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
| Câmp | Tip | Descriere |
|---|---|---|
| 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"'
| Cheie | Valoare |
|---|---|
| success |
|
| data->message | Shows whether entry was deleted |
Întrebări Frecvente
Instrument de Verificare a Calității
Algoritmi
Documentație API completă