turbo@mvsep.com
MVSEP-API:et ger programmatisk åtkomst för att skapa en separation, returnera resultaten, hämta platsinformation och kontrollera användarfunktioner.
För att använda denna API behöver du en API-nyckel. Du är inte inloggad, vänligen logga in för att få din API-token.
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.
För att skapa separation behöver du göra ett POST-anrop till följande url:
https://mvsep.com/api/separation/create
| Fält | Typ | Beskrivning |
|---|---|---|
| api_token | String | Din API-nyckel |
| audiofile | Binary | Ljudfil som ska behandlas. 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 | (valfritt) Separationstyp, standardinställning till 11 (Demucs3 Modell B (sång, trummor, bas, annat)) |
| add_opt1 | String | (valfritt) Första ytterligare fältet för separationstyp |
| add_opt2 | String | (valfritt) Andra ytterligare fältet för separationstyp |
| add_opt3 | String | (valfritt) Separation Typ tredje tilläggsfältet |
| output_format | Integer | (valfritt) utdataformat, standardinställning till 0 (mp3 (320kbps)) |
| is_demo | Boolean | (valfritt) om separationen ska publiceras på demosidan, standardinställning till false |
| Namn | Värde | 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:
|
| Namn | Värde |
|---|---|
| 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="<Your API Token>"'
--form 'sep_type="9"'
--form 'add_opt1="0"'
--form 'add_opt2="1"'
--form 'output_format="1"'
--form 'is_demo="1"'
| Nyckel | Värde |
|---|---|
| success |
|
| data | Innehåller extra information beroende på framgång-nyckeln |
| data -> link | Visar länk till "GET RESULT" URL för skapat jobb (visas endast när framgång är sant) |
| data -> hash | Visar skapad jobbhash (visas endast när framgång är sant) |
| data -> message | Visar beskrivningen av ett fel (visas endast när framgång är false) |
MVSEP API använder följande felkoder:
| Felkod | Betydelse |
|---|---|
| 400 | Vissa parametrar saknas eller är ogiltiga. Detta fel uppstår när du inte anger alla obligatoriska parametrar eller anger ogiltiga parametrar. |
| 401 |
Okänd eller ogiltig api_token. Detta fel uppstår om du använder en okänd API-nyckel
|
För att få separationens resultat behöver du göra ett GET-anrop till följande url:
https://mvsep.com/api/separation/get
| Fält | Typ | Beskrivning |
|---|---|---|
| hash | String | Separations-Hash |
| mirror | Integer | (valfritt) Använder en annan spegel om satt till 1, standard till 0. Kräver api_token och 1 kredit om satt till 1. |
| api_token | string | (valfritt) API-nyckel för användaren. Krävs om spegelparametern är inställd på 1. |
curl --location --request GET 'https://mvsep.com/api/separation/get?hash=20230327071601-0e3e5c6c85-13-dimensions.mp3'
| Nyckel | Värde |
|---|---|
| success |
|
| status |
|
| data | Innehåller extra information beroende på status-tangenten |
| data -> queue_count | Visar antalet obearbetade jobb i användarens prioritet (visas endast när status är |
| data -> current_order | Visar ordningen på användarens jobb (visas endast när status är |
| data -> message | Visar en beskrivning av status (visas på alla statusar, visar felorsak istället när status är failed) |
| data -> algorithm | Visar den algoritm som används för jobbet (visas endast när status är done) |
| data -> algorithm_description | Visar den algoritm som används för jobbet (visas endast när status är done) |
| data -> output_format | Visar utdataformatet för jobbet (visas endast när status är done) |
| data -> tags | Visar metataggarna för ljud (visas endast när status är done) |
| data -> input_file | Visar information om nedladdning av indataljud (visas endast när status är done) |
| data -> files | Visar information om nedladdning av utdataljud (visas endast när status är done) |
| data -> date | Visar bearbetningsdatum för jobbet (visas endast när status är |
| data -> finished_chunks | Visar antalet färdiga delar av ett stort jobb (visas endast när status är |
| data -> all_chunks | Visar numret på alla delar i ett stort jobb (visas endast när status är |
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
| Fält | Typ | Beskrivning |
|---|---|---|
| hash | String | Separations-Hash |
curl --location --request GET 'https://mvsep.com/api/separation/get-remote?hash=n2AwBjy4KsFZfqqR'
| Nyckel | Värde |
|---|---|
| success |
|
| status |
|
| data | Innehåller extra information beroende på status-tangenten |
| 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
| Fält | Typ | Beskrivning |
|---|---|---|
| api_token | string | Användarens API-nyckel |
| hash | string | Separations-Hash |
curl --location --request POST 'https://mvsep.com/api/separation/cancel' --form 'api_token="<Your API Token>"' --form 'hash="<hash>"'
| Nyckel | Värde |
|---|---|
| success |
|
För att få detaljerade data om separationstyper måste du göra ett GET-anrop till följande URL:
https://mvsep.com/api/app/algorithms
| Fält | Typ | Beskrivning |
|---|---|---|
| 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'
Returnerar data som en matris:
| Nyckel | Värde |
|---|---|
| render_id | Värde för separationstyp (ID) |
| name | Namnet på separationstypen |
| algorithm_group_id | Gruppen där separationstypen tillhör: |
| 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 |
För vem är den här separationstypen avsedd:
|
| order_id | Ordningen på separationstypen |
| price_coefficient |
Används för att beräkna hur många krediter jobbet tar från premiumanvändare. Använder denna formel : floor(<Audiofile duration in seconds> * price_coefficient / 60)?:1
|
| usage | Shows monthly usage count of separation type |
| rating | Shows monthly usage rating of separation type as array:
|
| algorithm_fields | Innehåller information om ytterligare fält av separationstypen |
| algorithm_fields -> name |
Visar vilket ytterligare fält av separationstypen:
|
| algorithm_fields -> text | Visningsnamn för det ytterligare fältet av separationstypen. |
| algorithm_fields -> options | JSON-kodade nyckelvärdekedjor för ytterligare fält |
| algorithm_fields -> default_key | Standardvärde för det extra fältet. En av nycklarna till <kod>algorithm_fields -> alternativ</kod> |
| algorithm_descriptions | Innehåller information om beskrivningar av separationstypen |
| algorithm_descriptions -> short_description | Liten beskrivning av separationstypen som inte använder HTML. |
| algorithm_descriptions -> long_description | Detaljerad beskrivning av separationstypen som använder HTML. |
| algorithm_descriptions -> lang | Specificerad språkkod för beskrivningen. |
Om du vill få information om de senaste nyheterna om MVSEP måste du göra ett GET-anrop till följande URL:
https://mvsep.com/api/app/news
| Fält | Typ | Beskrivning |
|---|---|---|
| lang | String | (valfritt) Språkkod med 2 bokstäver (en, ru) |
| start | Integer | (valfritt) Startpunktsförskjutning, standardvärdet är 0 (dvs. starta från senaste) |
| limit | Integer | (valfritt) Maximalt antal returnerade resultat, standardvärdet är 10, maxvärdet är 20. |
curl --location --request GET 'https://mvsep.com/api/app/news?lang=en&start=2&limit=1'
Returnerar data som en matris:
| Nyckel | Värde |
|---|---|
| title | Titel på nyheten |
| lang | Titel på nyheten |
| text | Fullständig beskrivning av nyheten |
| created_at | Datum för beskedet |
To get site queue information, you need to make a GET call to the following url:
https://mvsep.com/api/app/queue
| Fält | Typ | Beskrivning |
|---|---|---|
| api_token | String | (optional) Användarens API-nyckel |
curl --location --request GET 'https://mvsep.com/api/app/queue'
| Nyckel | Värde |
|---|---|
| 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):
|
Om du vill få information om demoseparationer måste du göra ett GET-anrop till följande URL:
https://mvsep.com/api/app/demo
| Fält | Typ | Beskrivning |
|---|---|---|
| start | Integer | (valfritt) Startpunktsförskjutning, standardvärdet är 0 (dvs. starta från senaste) |
| limit | Integer | (valfritt) Maximalt antal returnerade resultat, standardvärdet är 10, maxvärdet är 20. |
curl --location --request GET 'https://mvsep.com/api/app/demo?start=0&limit=2'
Returnerar data som en matris:
| Nyckel | Värde |
|---|---|
| hash | Separations-Hash |
| date | Datum för separationen |
| input_audio | URL för indataljud |
| size | Storlek på inmatat ljud |
| algorithm | Innehåller grundläggande information om använd separationstyp (se fliken HÄMTA SEPARATIONSTYPER för information om returnerade parametrar) |
Om du vill autentisera användaren och hämta användarens API-nyckel måste du göra ett POST-anrop till följande URL:
https://mvsep.com/api/app/login
| Fält | Typ | Beskrivning |
|---|---|---|
| String | Användarens e-postadress | |
| password | String | Användarens lösenord |
curl --location --request POST 'https://mvsep.com/api/app/login' --form 'email="<Användarens e-postadress>"' --form 'password="<Användarens lösenord>"'
| Nyckel | Värde |
|---|---|
| success |
|
| data | Innehåller information om när autentiseringsuppgifterna är giltiga |
| data -> name | Användarens namn |
| data -> email | Användarens e-postadress |
| data -> api_token | Användarens API-nyckel. Se till att förvara den i säker lagring och använd för efterföljande åtgärder. |
| data -> premium_minutes | Krediter som är kvar för användaren |
| data -> premium_enabled |
Om användaren har tillåtit att krediter spenderas.
|
| data -> long_filenames_enabled |
Om användaren vill ha extra information i filnamn:
|
MVSEP API använder följande felkoder:
| Felkod | Betydelse |
|---|---|
| 400 | Felaktiga autentiseringsuppgifter har angetts |
Om du vill registrera användaren på MVSEP-webbplatsen måste du göra ett POST-anrop till följande URL:
https://mvsep.com/api/app/register
| Fält | Typ | Beskrivning |
|---|---|---|
| name | String | Användarens namn |
| String | Användarens e-postadress | |
| password | String | Användarens lösenord |
| password_confirmation | String | Upprepa användarens lösenord |
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"'
| Nyckel | Värde |
|---|---|
| success |
|
| message | Inträffar när formuläret är giltigt |
MVSEP API använder följande felkoder:
| Felkod | Betydelse |
|---|---|
| 400 | Formuläret är ogiltigt |
För att få användarinformation måste du göra ett GET-anrop till följande URL:
https://mvsep.com/api/app/user
| Fält | Typ | Beskrivning |
|---|---|---|
| api_token | String | Användarens API-nyckel |
curl --location --request GET 'https://mvsep.com/api/app/user?api_token=<Your API Token>'
| Nyckel | Värde |
|---|---|
| success |
|
| data | Innehåller information om när autentiseringsuppgifterna är giltiga |
| data -> name | Användarens namn |
| data -> email | Användarens e-postadress |
| data -> api_token | Användarens API-nyckel. Se till att förvara den i säker lagring och använd för efterföljande åtgärder. |
| data -> premium_minutes | Krediter som är kvar för användaren |
| data -> premium_enabled |
Om användaren har tillåtit att krediter spenderas.
|
| data -> long_filenames_enabled |
Om användaren vill ha extra information i filnamn:
|
| data -> current_queue | Visar pågående separationer för användaren |
MVSEP API använder följande felkoder:
| Felkod | Betydelse |
|---|---|
| 400 | Ogiltig API-nyckel |
För att få grundläggande informationssepareringshistorik för användaren måste du ringa ett GET-anrop till följande webbadress:
https://mvsep.com/api/app/separation_history
| Fält | Typ | Beskrivning |
|---|---|---|
| api_token | String | Användarens API-nyckel |
| start | Integer | (valfritt) Startpunktsförskjutning, standardvärdet är 0 (dvs. starta från senaste) |
| limit | Integer | (valfritt) Maximalt antal returnerade resultat, standardvärdet är 10, maxvärdet är 20. |
curl --location --request GET 'https://mvsep.com/api/app/separation_history?api_token=<Your API Token>&start=1&limit=2'
| Nyckel | Värde |
|---|---|
| success |
|
| data | Innehåller grundläggande informationsuppsättning om tidigare separationer |
| data -> hash | Separations-Hash |
| data -> job_exists | Innehåller grundläggande informationsuppsättning om tidigare separationer |
| data -> credits | Hur många poäng som användes för jobbet, noll om separation inte finns |
| data -> time_left | Ungefärlig tid kvar tills jobbet tas bort |
| data -> algorithm | Innehåller grundläggande information om använd separationstyp (se fliken HÄMTA SEPARATIONSTYPER för information om returnerade parametrar) |
MVSEP API använder följande felkoder:
| Felkod | Betydelse |
|---|---|
| 400 | Ogiltig API-nyckel |
För att aktivera premiumanvändning för användaren måste du ringa ett POST-anrop till följande url:
https://mvsep.com/api/app/enable_premium
| Fält | Typ | Beskrivning |
|---|---|---|
| api_token | String | Användarens API-nyckel |
curl --location --request POST 'https://mvsep.com/api/app/enable_premium' --form 'api_token="<Your API Token>"'
| Nyckel | Värde |
|---|---|
| success |
|
| message | Informerar om operationens status |
MVSEP API använder följande felkoder:
| Felkod | Betydelse |
|---|---|
| 400 | Ogiltig API-nyckel |
För att inaktivera premiumanvändning för användaren måste du ringa ett POST-anrop till följande webbadress:
https://mvsep.com/api/app/disable_premium
| Fält | Typ | Beskrivning |
|---|---|---|
| api_token | String | Användarens API-nyckel |
curl --location --request POST 'https://mvsep.com/api/app/disable_premium' --form 'api_token="<Your API Token>"'
| Nyckel | Värde |
|---|---|
| success |
|
| message | Informerar om operationens status |
MVSEP API använder följande felkoder:
| Felkod | Betydelse |
|---|---|
| 400 | Ogiltig API-nyckel |
Om du vill aktivera långa filnamn för användaren måste du göra ett POST-anrop till följande URL:
https://mvsep.com/api/app/enable_long_filenames
| Fält | Typ | Beskrivning |
|---|---|---|
| api_token | String | Användarens API-nyckel |
curl --location --request POST 'https://mvsep.com/api/app/enable_long_filenames' --form 'api_token="<Your API Token>"'
| Nyckel | Värde |
|---|---|
| success |
|
| message | Informerar om operationens status |
MVSEP API använder följande felkoder:
| Felkod | Betydelse |
|---|---|
| 400 | Ogiltig API-nyckel |
Om du vill inaktivera långa filnamn för användaren måste du göra ett POST-anrop till följande URL:
https://mvsep.com/api/app/disable_long_filenames
| Fält | Typ | Beskrivning |
|---|---|---|
| api_token | String | Användarens API-nyckel |
curl --location --request POST 'https://mvsep.com/api/app/disable_long_filenames' --form 'api_token="<Your API Token>"'
| Nyckel | Värde |
|---|---|
| success |
|
| message | Informerar om operationens status |
MVSEP API använder följande felkoder:
| Felkod | Betydelse |
|---|---|
| 400 | Ogiltig API-nyckel |
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
| Fält | Typ | Beskrivning |
|---|---|---|
| start | Integer | (valfritt) Startpunktsförskjutning, standardvärdet är 0 (dvs. starta från senaste) |
| limit | Integer | (valfritt) Maximalt antal returnerade resultat, standardvärdet är 10, maxvärdet är 20. |
curl --location --request GET 'https://mvsep.com/api/quality_checker/queue?&start=1&limit=2'
Returnerar data som en matris:
| Nyckel | Värde |
|---|---|
| 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
| Fält | Typ | Beskrivning |
|---|---|---|
| dataset_type | String | Dataset Type, defaults to 0 if not given
|
| start | Integer | (valfritt) Startpunktsförskjutning, standardvärdet är 0 (dvs. starta från senaste) |
| limit | Integer | (valfritt) Maximalt antal returnerade resultat, standardvärdet är 10, maxvärdet är 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'
| Nyckel | Värde |
|---|---|
| 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
| Fält | Typ | Beskrivning |
|---|---|---|
| api_token | String | (required) Din API-nyckel |
| 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"'
| Nyckel | Värde |
|---|---|
| success |
|
| data | Contains information about entry |
| data -> id | ID of the entry. |
| data -> link | Link to the entry. |
MVSEP API använder följande felkoder:
| Felkod | Betydelse |
|---|---|
| 400 | Formuläret är ogiltigt |
| 401 |
Okänd eller ogiltig api_token. Detta fel uppstår om du använder en okänd API-nyckel
|
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
| Fält | Typ | Beskrivning |
|---|---|---|
| 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
| Fält | Typ | Beskrivning |
|---|---|---|
| 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"'
| Nyckel | Värde |
|---|---|
| success |
|
| data->message | Shows whether entry was deleted |
turbo@mvsep.com