Az MVSEP API programozott hozzáférést biztosít a szeparáció 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.
Fontos megjegyezni, hogy a prémium felhasználók korlátlan számú egyidejű feladatot kérhetnek, míg a nem prémium felhasználók csak 1 egyidejű feladatot kérhetnek.
Az MVSEP regionális API-végpontokat üzemeltet. Minden régió egy közös fiókadatbázist használ, így ugyanaz a fiók, API-kulcs és feladat-hash működik mindenhol:
https://de.mvsep.com/apihttps://de2.mvsep.com/apihttps://hk.mvsep.com/apiA https://mvsep.com/api címre érkező kéréseket földrajzi alapon irányítjuk: az Európából érkező hívások a de, az Észak-Ázsiából érkezők a hk, minden más hívás pedig a de2 régióba kerül. API-integrációk esetén azt javasoljuk, hogy kifejezetten egy regionális végpontot hívjanak meg — így a feladat teljes életciklusa egyetlen gazdagépen marad, függetlenül attól, hogy a kérések honnan érkeznek.
Minden szeparációt abban a régióban dolgozunk fel és tárolunk, ahol azt létrehozták, és a válaszokban visszaadott letöltési URL-ek mindig az adott régió gazdagépére mutatnak. A legjobb teljesítmény érdekében válassza ki a szervereinek legközelebb eső végpontot, és használja ugyanazt a gazdagépet a feladat teljes életciklusa alatt — a létrehozás, az állapotlekérdezés és a fájlletöltés során egyaránt.
Bármely régióból lekérdezhető bármely feladat állapota (az adatbázis közös), de magukat a kimeneti fájlokat mindig az a régió szolgáltatja, amelyikhez a feladat tartozik.
A szeparáció létrehozásához POST-hívást kell indítania a következő URL-re:
https://mvsep.com/api/separation/create
| Mező | Típus | Leírás |
|---|---|---|
| api_token | Karakterlánc | Az Ön API-kulcsa |
| audiofile | Bináris | Feldolgozandó hangfájl. Nem szükséges, ha az url paraméter be van állítva, vagy a modell nem használ fájlbemenetet. Matchering modellek esetén a target_audiofile és a reference_audiofile paramétereket kell használni bemenetként az audiofile helyett. |
| url | Karakterlánc | Hivatkozás a hangfájlra. Nem szükséges, ha az audiofile paraméter be van állítva. |
| remote_type | Karakterlánc | (opcionális) A hangfájl távoli típusa. Alapértelmezés szerint direct. Nem szükséges, ha az audiofile paraméter be van állítva. A támogatott típusok: direct (közvetlen letöltés), mega (MEGA), drive (Google Drive), dropbox (Dropbox). |
| sep_type | Egész szám | (opcionális) Szeparációs típus, alapértelmezés szerint 20. Ez a szeparációs típus azonosítója; további információért lásd a SZEPARÁCIÓS TÍPUSOK LEKÉRÉSE szakaszt. A rendszer figyelmen kívül hagyja, ha meg van adva a <code class="higlighted">preset_id</code>. |
| preset_id | Egész szám | (opcionális) Egyetlen algoritmus helyett az egyik mentett előbeállítását futtatja le a fájlon. Vagy a sep_type, vagy a preset_id értéket adja meg — az előbeállítás maga határozza meg a saját algoritmusait, opcióit és kimeneti formátumait, ezért mellette a sep_type, az add_opt mezők és az output_format egyaránt figyelmen kívül maradnak. A válasz egy hash-t ad vissza, amelyet pontosan úgy kérdezhet le, mint egy szeparációt; az eredmény az előbeállítás minden egyes kimeneti csomópontjához egy bejegyzést tartalmaz. Az azonosítókat az alábbi, előbeállításokat felsoroló táblázatban találja. |
| add_opt1 | Karakterlánc | (opcionális) A szeparációs típus első kiegészítő mezője |
| add_opt2 | Karakterlánc | (opcionális) A szeparációs típus második kiegészítő mezője |
| add_opt3 | Karakterlánc | (opcionális) A szeparációs típus harmadik kiegészítő mezője |
| output_format | Egész szám | (opcionális) kimeneti formátum, alapértelmezés szerint 0 (mp3 (320 kbps)) |
| is_demo | Logikai | (opcionális) közzé kell-e tenni a szeparációt a demó oldalon; alapértelmezés szerint false |
| webhook_url | Karakterlánc | (optional) A URL we will POST the finished result to, so you do not have to keep polling. The body is the same JSON as GET SEPARATION. This overrides the account-wide address set on the webhooks page, which is useful when several of your own users share one API token. Must be a publicly reachable http or https address. |
| Név | Érték | További mezők |
|---|---|---|
| Ensemble (vocals, instrum) | 26 | Kulcs: add_opt1 Név: Output files Lehetőségek:
Kulcs: add_opt2 Név: Model Type Lehetőségek:
|
| Ensemble (vocals, instrum, bass, drums, other) | 28 | Kulcs: add_opt1 Név: Output files Lehetőségek:
Kulcs: add_opt2 Név: Model Type Lehetőségek:
|
| Ensemble All-In (vocals, bass, drums, piano, guitar, lead/back vocals, other) | 30 | Kulcs: add_opt1 Név: Output files Lehetőségek:
Kulcs: add_opt2 Név: Model Type Lehetőségek:
|
| BS Roformer SW (vocals, bass, drums, guitar, piano, other) | 63 | |
| Demucs4 HT (vocals, drums, bass, other) | 20 | Kulcs: add_opt1 Név: Model type Lehetőségek:
|
| BS Roformer (vocals, instrumental) | 40 | Kulcs: add_opt1 Név: Vocal model type Lehetőségek:
Kulcs: add_opt2 Név: Overlap Lehetőségek:
Kulcs: add_opt3 Név: Set of stems Lehetőségek:
|
| BS PolarFormer (vocals, instrumental) | 123 | Kulcs: add_opt1 Név: Model type Lehetőségek:
Kulcs: add_opt2 Név: Overlap Lehetőségek:
|
| MelBand Roformer (vocals, instrumental) | 48 | Kulcs: add_opt1 Név: Vocal model type Lehetőségek:
Kulcs: add_opt2 Név: Overlap Lehetőségek:
|
| MDX23C (vocals, instrumental) | 25 | Kulcs: add_opt1 Név: Vocal model type Lehetőségek:
|
| SCNet (vocals, instrumental) | 46 | Kulcs: add_opt1 Név: Vocal model type Lehetőségek:
|
| MDX B (vocals, instrumental) | 23 | Kulcs: add_opt1 Név: Vocal model type Lehetőségek:
|
| Ultimate Vocal Remover VR (vocals, music) | 9 | Kulcs: add_opt1 Név: Model Type Lehetőségek:
Kulcs: add_opt2 Név: Agressiveness Lehetőségek:
|
| Demucs4 Vocals 2023 (vocals, instrum) | 27 | |
| MVSep Karaoke (lead/back vocals) | 49 | Kulcs: add_opt1 Név: Karaoke model type Lehetőségek:
Kulcs: add_opt2 Név: Extraction type Lehetőségek:
|
| MDX-B Karaoke (lead/back vocals) | 12 | Kulcs: add_opt1 Név: Karaoke model type Lehetőségek:
|
| MVSep Crowd removal (crowd, other) | 34 | Kulcs: add_opt1 Név: Model type Lehetőségek:
|
| Medley Vox (Multi-singer separation) | 53 | Kulcs: add_opt1 Név: Model type Lehetőségek:
|
| MVSep Multichannel BS (vocals, instrumental) | 43 | Kulcs: add_opt1 Név: Model Type Lehetőségek:
Kulcs: add_opt2 Név: Processing Mode Lehetőségek:
|
| MVSep Male/Female separation | 57 | Kulcs: add_opt1 Név: Model type Lehetőségek:
Kulcs: add_opt2 Név: How to extract Lehetőségek:
|
| MVSep Choir (choir, other) | 112 | Kulcs: add_opt2 Név: How to extract Lehetőségek:
|
| MVSep SATB Choir (soprano, alto, tenor, bass) | 111 | Kulcs: add_opt1 Név: Model type Lehetőségek:
Kulcs: add_opt2 Név: How to extract Lehetőségek:
|
| MVSep Drums (drums, other) | 44 | Kulcs: add_opt1 Név: Drums model type Lehetőségek:
Kulcs: add_opt2 Név: How to extract Lehetőségek:
Kulcs: add_opt3 Név: Output files Lehetőségek:
|
| MVSep Bass (bass, other) | 41 | Kulcs: add_opt1 Név: Bass model type Lehetőségek:
Kulcs: add_opt2 Név: How to extract Lehetőségek:
Kulcs: add_opt3 Név: Output files Lehetőségek:
|
| MVSep Synth (synth, other) | 88 | Kulcs: add_opt1 Név: How to extract Lehetőségek:
|
| DrumSep (4-6 stems: kick, snare, cymbals, toms, ride, hh, crash) | 37 | Kulcs: add_opt1 Név: Model Type Lehetőségek:
Kulcs: add_opt2 Név: Preprocess Lehetőségek:
|
| MVSep Piano (piano, other) | 29 | Kulcs: add_opt1 Név: Piano model type Lehetőségek:
|
| MVSep Digital Piano (digital-piano, other) | 79 | Kulcs: add_opt2 Név: How to extract Lehetőségek:
|
| MVSep Keys (keys, other) | 106 | |
| MVSep Organ (organ, other) | 58 | Kulcs: add_opt1 Név: Organ model type Lehetőségek:
|
| MVSep Harpsichord (harpsichord, other) | 91 | |
| MVSep Accordion (accordion, other) | 99 | |
| MVSep Vibraphone | 129 | |
| MVSep Metal Bars | 130 | |
| MVSep Rhodes | 131 | |
| MVSep Clavinet | 135 | |
| MVSep Mellotron | 136 | |
| MVSep Guitar (guitar, other) | 31 | Kulcs: add_opt1 Név: Guitar model type Lehetőségek:
|
| MVSep Acoustic Guitar (acoustic-guitar, other) | 66 | Kulcs: add_opt2 Név: How to extract Lehetőségek:
|
| MVSep Electric Guitar (electric-guitar, other) | 81 | Kulcs: add_opt2 Név: How to extract Lehetőségek:
|
| MVSep Lead/Rhythm Guitar (lead-guitar, rhythm-guitar) | 101 | Kulcs: add_opt1 Név: Model type Lehetőségek:
|
| MVSep Pedal Steel Guitar | 124 | |
| 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 | Kulcs: add_opt1 Név: String model type Lehetőségek:
Kulcs: add_opt2 Név: How to extract Lehetőségek:
|
| MVSep Violin (violin, other) | 65 | |
| MVSep Viola (viola, other) | 69 | Kulcs: add_opt2 Név: How to extract Lehetőségek:
|
| MVSep Cello (cello, other) | 70 | Kulcs: add_opt2 Név: How to extract Lehetőségek:
|
| MVSep Double Bass (double-bass, other) | 73 | Kulcs: add_opt2 Név: How to extract Lehetőségek:
|
| MVSep Wind (wind, other) | 54 | Kulcs: add_opt1 Név: Wind model type Lehetőségek:
Kulcs: add_opt2 Név: How to extract Lehetőségek:
Kulcs: add_opt3 Név: Output files Lehetőségek:
|
| MVSep Brass (brass, other) | 107 | Kulcs: add_opt1 Név: How to extract Lehetőségek:
|
| MVSep Woodwind (woodwind, other) | 108 | Kulcs: add_opt1 Név: How to extract Lehetőségek:
|
| MVSep Saxophone (saxophone, other) | 61 | Kulcs: add_opt1 Név: Model type Lehetőségek:
|
| MVSep Flute (flute, other) | 67 | Kulcs: add_opt1 Név: Flute model type Lehetőségek:
Kulcs: add_opt2 Név: How to extract Lehetőségek:
|
| MVSep Trumpet (trumpet, other) | 71 | Kulcs: add_opt2 Név: How to extract Lehetőségek:
|
| MVSep Trombone (trombone, other) | 75 | Kulcs: add_opt2 Név: How to extract Lehetőségek:
|
| MVSep Oboe (oboe, other) | 77 | Kulcs: add_opt2 Név: How to extract Lehetőségek:
|
| MVSep Clarinet (clarinet, other) | 78 | Kulcs: add_opt2 Név: How to extract Lehetőségek:
|
| MVSep French Horn (french-horn, other) | 82 | Kulcs: add_opt2 Név: How to extract Lehetőségek:
|
| MVSep Harmonica (harmonica, other) | 87 | Kulcs: add_opt2 Név: How to extract Lehetőségek:
|
| MVSep Tuba (tuba, other) | 92 | |
| MVSep Bassoon (bassoon, other) | 93 | |
| MVSep Bagpipes (bagpipes , other) | 116 | Kulcs: add_opt2 Név: How to extract Lehetőségek:
|
| MVSep Whistle | 132 | |
| 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 | Kulcs: add_opt2 Név: How to extract Lehetőségek:
|
| MVSep Celesta (celesta, other) | 110 | Kulcs: add_opt2 Név: How to extract Lehetőségek:
|
| MVSep Clap | 133 | |
| MVSep Cowbell | 128 | |
| MVSep Demucs4HT DNR (speech, music, effects) | 24 | Kulcs: add_opt1 Név: Model type Lehetőségek:
|
| BandIt Plus (speech, music, effects) | 36 | |
| BandIt v2 (speech, music, effects) | 45 | Kulcs: add_opt1 Név: Model Type Lehetőségek:
|
| MVSep DnR v3 (speech, music, effects) | 56 | Kulcs: add_opt1 Név: Model type Lehetőségek:
Kulcs: add_opt2 Név: How to extract Lehetőségek:
Kulcs: add_opt3 Név: Output files Lehetőségek:
|
| MVSep Braam | 117 | |
| MVSep Risers | 125 | |
| MVSep FX | 122 | |
| Apollo Enhancers (by JusperLee, Lew, baicai1145) | 51 | Kulcs: add_opt1 Név: Model type Lehetőségek:
Kulcs: add_opt2 Név: Cutoff (Hz) Lehetőségek:
|
| Reverb Removal (noreverb) | 22 | Kulcs: add_opt1 Név: Model Type Lehetőségek:
Kulcs: add_opt2 Név: Preprocess Lehetőségek:
|
| DeNoise by aufr33 and gabox | 47 | Kulcs: add_opt1 Név: Model type Lehetőségek:
|
| AudioSR (Super Resolution) | 59 | Kulcs: add_opt1 Név: Cutoff (Hz) Lehetőségek:
|
| FlashSR (Super Resolution) | 60 | |
| Stable Audio Open Gen | 62 | Kulcs: add_opt1 Név: Text prompt Lehetőségek: Kulcs: add_opt2 Név: Length (in seconds) Lehetőségek:
|
| Whisper (extract text from audio) | 39 | Kulcs: add_opt1 Név: Model type Lehetőségek:
Kulcs: add_opt2 Név: Transcription type Lehetőségek:
|
| Parakeet (extract text from audio) | 64 | Kulcs: add_opt1 Név: Model type Lehetőségek:
Kulcs: add_opt2 Név: Version Lehetőségek:
|
| VibeVoice (Voice Cloning) | 103 | Kulcs: add_opt1 Név: Model type Lehetőségek:
Kulcs: add_opt2 Név: Text prompt Lehetőségek: Kulcs: add_opt3 Név: Extract vocals first Lehetőségek:
|
| VibeVoice (TTS) | 104 | Kulcs: add_opt1 Név: Model type Lehetőségek:
Kulcs: add_opt2 Név: Text prompt Lehetőségek: |
| Qwen3-TTS (Custom Voice) | 118 | Kulcs: add_opt1 Név: Text prompt Lehetőségek: Kulcs: add_opt2 Név: Speaker Lehetőségek:
Kulcs: add_opt3 Név: Language Lehetőségek:
Kulcs: add_opt4 Név: Voice description Lehetőségek: |
| Qwen3-TTS (Voice Design) | 119 | Kulcs: add_opt1 Név: Text prompt Lehetőségek: Kulcs: add_opt2 Név: Voice description Lehetőségek: Kulcs: add_opt3 Név: Language Lehetőségek:
|
| Qwen3-TTS (Voice Cloning) | 120 | Kulcs: add_opt1 Név: Text prompt Lehetőségek: Kulcs: add_opt2 Név: Reference text in audio (optional) Lehetőségek: Kulcs: add_opt3 Név: Language Lehetőségek:
Kulcs: add_opt4 Név: Extract vocals first Lehetőségek:
|
| Mega 53-stem Model | 126 | |
| Upmixing by Jazzpear | 137 | |
| Bark (Speech Gen) | 115 | Kulcs: add_opt1 Név: Text prompt Lehetőségek: Kulcs: add_opt2 Név: Speaker Lehetőségek:
|
| MVSep MultiSpeaker (MDX23C) | 42 | Kulcs: add_opt1 Név: Model Type Lehetőségek:
|
| Aspiration (by Sucial) | 50 | Kulcs: add_opt1 Név: Model type Lehetőségek:
|
| Phantom Centre extraction | 55 | Kulcs: add_opt1 Név: Model type Lehetőségek:
|
| Matchering (by sergree) | 68 | |
| SOME (Singing-Oriented MIDI Extractor) | 80 | Kulcs: add_opt1 Név: How to use Lehetőségek:
|
| Transkun (Piano -> MIDI) | 113 | Kulcs: add_opt1 Név: How to extract Lehetőségek:
|
| Basic Pitch (MIDI Extraction) | 114 | |
| ADTOF Plus (Drums -> MIDI) | 127 | Kulcs: add_opt1 Név: How to extract Lehetőségek:
|
| HeartMuLa (Song Gen) | 121 | Kulcs: add_opt1 Név: Lyrics Lehetőségek: Kulcs: add_opt10 Név: Topic Lehetőségek:
Kulcs: add_opt2 Név: Tags (optional) Lehetőségek: Kulcs: add_opt3 Név: Genre Lehetőségek:
Kulcs: add_opt4 Név: Timbre Lehetőségek:
Kulcs: add_opt5 Név: Gender Lehetőségek:
Kulcs: add_opt6 Név: Mood Lehetőségek:
Kulcs: add_opt7 Név: Instrument Lehetőségek:
Kulcs: add_opt8 Név: Scene Lehetőségek:
Kulcs: add_opt9 Név: Region Lehetőségek:
|
| Demucs3 Model (vocals, drums, bass, other) | 10 | Kulcs: add_opt1 Név: Model type Lehetőségek:
|
| MDX A/B (vocals, drums, bass, other) | 7 | Kulcs: add_opt1 Név: Vocal model type Lehetőségek:
|
| Vit Large 23 (vocals, instrum) | 33 | Kulcs: add_opt1 Név: Model type Lehetőségek:
|
| UVRv5 Demucs (vocals, music) | 17 | Kulcs: add_opt1 Név: Model Type Lehetőségek:
|
| 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 | Kulcs: add_opt1 Név: Model type Lehetőségek:
|
| UnMix | 3 | Kulcs: add_opt1 Név: Model type Lehetőségek:
|
| Zero Shot (Query Based) (Low quality) | 14 | Kulcs: add_opt1 Név: Model Type Lehetőségek:
|
| LarsNet (kick, snare, cymbals, toms, hihat) | 38 | Kulcs: add_opt1 Név: Model type Lehetőségek:
|
Az előbeállítások kizárólag az őket létrehozó fiókhoz tartoznak, ezért ez a táblázat az Ön saját előbeállításait és a válogatott előbeállításokat mutatja. Létrehozni és szerkeszteni őket az előbeállítás-szerkesztőben tudja.
Még nincs egyetlen előbeállítása sem. Jelentkezzen be, és hozzon létre egyet az előbeállítás-szerkesztőben; az azonosítója itt fog megjelenni.
| 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 success kulcs függvényében további információkat tartalmaz. |
| data -> link | Megjeleníti a létrehozott feladat "EREDMÉNY LEKÉRÉSE" URL-címére mutató hivatkozást (csak akkor jelenik meg, ha a success értéke true) |
| data -> hash | Megjeleníti a létrehozott feladat hashét (csak akkor jelenik meg, ha a success értéke true) |
| data -> message | Megjeleníti a hiba leírását (csak akkor jelenik meg, ha a success értéke false) |
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
|
A szeparáció 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
Ugyanez a végpont adja vissza az előbeállítás-futtatásokat is: a preset_id alapján kapott hasht pontosan úgy kérdezze le, mint egy szeparációét. A válasz szerkezete azonos — a status a waiting és a processing állapoton át jut el a done állapotig —, a data.type értéke pedig preset_run. A data.files minden egyes eleme az előbeállítás egy-egy kimeneti csomópontja, amelynek a neve nem a stem neve, hanem a csomópont címkéje. Egy futtatás csak azt a fiókot illeti meg, amelyik létrehozta.
| Mező | Típus | Leírás |
|---|---|---|
| hash | Karakterlánc | A szeparáció hash-e |
| mirror | Egész szám | (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 | Karakterlánc | (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 | A status kulcs függvényében további információkat tárol |
| data -> queue_count | Megjeleníti a felhasználó prioritási sorában várakozó, még feldolgozatlan feladatok számát (csak akkor jelenik meg, ha a status értéke waiting vagy distributing) |
| data -> current_order | Megjeleníti a felhasználó feladatának sorrendjét (csak akkor jelenik meg, ha a status értéke waiting vagy distributing) |
| data -> message | Megjeleníti az állapot leírását (minden állapotnál megjelenik, helyette a hiba okát mutatja, ha a status értéke failed) |
| data -> algorithm | Megjeleníti a feladatnál használt algoritmust (csak akkor jelenik meg, ha a status értéke done) |
| data -> algorithm_description | Megjeleníti a feladathoz használt algoritmus részleteit (csak akkor jelenik meg, ha a status értéke done) |
| data -> output_format | Megjeleníti a feladat kimeneti formátumát (csak akkor jelenik meg, ha a status értéke done) |
| data -> tags | Megjeleníti az audio metacímkéket (csak akkor jelenik meg, ha a status értéke done) |
| data -> input_file | Megjeleníti a bemeneti hangletöltés részleteit (csak akkor jelenik meg, ha a status értéke done) |
| data -> files | Megjeleníti a kimeneti hangok letöltésének részleteit (csak akkor jelenik meg, ha a status értéke done) |
| data -> date | Megjeleníti a feladat feldolgozásának dátumát (csak akkor jelenik meg, ha a status értéke done) |
| data -> finished_chunks | Egy nagy feladat befejezett részeinek számát mutatja (csak akkor jelenik meg, ha a status értéke distributing) |
| data -> all_chunks | Egy nagy feladat összes részének számát mutatja (csak akkor jelenik meg, ha a status értéke distributing) |
Delete one of your own separations — a regular job or a preset run. This removes the record and its output files. A separation that is still processing must be cancelled first. Deleting does not refund credits, since the work has already run.
POST https://mvsep.com/api/separation/delete
Bármely régióból lekérdezhető bármely feladat állapota (az adatbázis közös), de magukat a kimeneti fájlokat mindig az a régió szolgáltatja, amelyikhez a feladat tartozik.
| Mező | Típus | Leírás |
|---|---|---|
| hash | Karakterlánc | A szeparáció hash-e |
| api_token | Karakterlánc | API key of the user. Required. |
curl --location --request POST 'https://mvsep.com/api/separation/delete'
--form 'api_token="<Az API-tokenje>"'
--form 'hash="20230327071601-0e3e5c6c85-13-dimensions.mp3"'
| Kulcs | Érték |
|---|---|
| success |
|
| data -> message | Megjeleníti az állapot leírását (minden állapotnál megjelenik, helyette a hiba okát mutatja, ha a status értéke failed) |
Egy távoli feladat eredményének lekéréséhez GET hívást kell kezdeményezni a következő URL-címre:
https://mvsep.com/api/separation/get-remote
| Mező | Típus | Leírás |
|---|---|---|
| hash | Karakterlánc | A szeparáció hash-e |
curl --location --request GET 'https://mvsep.com/api/separation/get-remote?hash=n2AwBjy4KsFZfqqR'
| Kulcs | Érték |
|---|---|
| success |
|
| status |
|
| data | A status kulcs függvényében további információkat tárol |
| data -> queue_count | Megjeleníti a feldolgozatlan feladatok számát a felhasználó prioritásában (csak akkor látható, ha a status értéke waiting). |
| data -> current_order | A felhasználó feladatainak sorrendjét mutatja (csak akkor látható, ha a status értéke waiting). |
| data -> message | Megjeleníti az állapot leírását (csak akkor, ha a status értéke failed). |
| data -> link | Megjeleníti a létrehozott feladat „EREDMÉNY LEKÉRÉSE” URL-címére mutató linket (csak akkor látható, ha a status értéke done). |
| data -> hash | A szeparáció hash-e (csak akkor jelenik meg, ha a status értéke done). |
A szeparáció megszakításához és a felhasznált kreditek visszatérítéséhez (ha a szeparáció még nem feldolgozás alatt áll) POST hívást kell kezdeményezni a következő URL-címre:
https://mvsep.com/api/separation/cancel
| Mező | Típus | Leírás |
|---|---|---|
| api_token | Karakterlánc | A felhasználó API kulcsa |
| hash | Karakterlánc | A szeparáció hash-e |
curl --location --request POST 'https://mvsep.com/api/separation/cancel' --form 'api_token="<Az API-tokenje>"' --form 'hash="<hash>"'
| Kulcs | Érték |
|---|---|
| success |
|
A szeparációs 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
| Mező | Típus | Leírás |
|---|---|---|
| scopes | Karakterlánc | Belefoglalja-e a különböző bemeneti formákat használó modelleket.
single_upload, ha nincs megadva. Az összes modell lekéréséhez állítsa be a scopes=single_upload,no_upload,matchering_upload értéket.
|
curl --location --request GET 'https://mvsep.com/api/app/algorithms'
Az adatokat tömbként adja vissza:
| Kulcs | Érték |
|---|---|
| render_id | Szeparáció típusának értéke (ID) |
| name | A szeparáció típusának neve |
| algorithm_group_id | A csoport, ahová a szeparáció típusa tartozik: |
| algorithm_group | Információkat tartalmaz arról az algoritmuscsoportról, amelyhez az algoritmus tartozik. |
| algorithm_group -> name | Az algoritmuscsoport neve. |
| audio_widget |
Az algoritmushoz használandó audio widget típusa. Ezzel meghatározható, hogyan jelenjen meg az algoritmus audiolejátszója a felhasználói felületen. A lehetséges értékek a következők:
|
| orientation |
Kinek szól ez a szeparációs típus:
|
| order_id | A szeparáció típusának sorrendje |
| price_coefficient |
Annak kiszámítására szolgál, hogy egy feladat hány kreditet von le 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 | A szeparációs típus havi használati számát mutatja. |
| rating | A szeparációs típus havi használati értékelését mutatja tömbként:
|
| algorithm_fields | Információkat tartalmaz a szeparáció típusú további mezőkről |
| algorithm_fields -> name |
Megmutatja, hogy a szeparációtípus melyik további mezője:
|
| algorithm_fields -> text | A szeparációtí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 a szeparáció típusának leírásáról |
| algorithm_descriptions -> short_description | A HTML-t nem használó szeparációs típus kis leírása. |
| algorithm_descriptions -> long_description | A HTML-t használó szeparációs 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
| Mező | Típus | Leírás |
|---|---|---|
| lang | Karakterlánc | (nem kötelező) 2 betűs nyelvi kód (en, ru) |
| start | Egész szám | (opcionális) Kezdőpont-eltolás, alapértelmezés szerint 0 (azaz a legfrissebbtől indul) |
| limit | Egész szám | (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ír címe |
| lang | A hír címe |
| text | A hír teljes leírása |
| created_at | A hír dátuma |
A webhely várólistájának információinak lekéréséhez GET hívást kell kezdeményeznie a következő URL-címre:
https://mvsep.com/api/app/queue
| Mező | Típus | Leírás |
|---|---|---|
| api_token | Karakterlánc | (opcionális) A felhasználó API kulcsa |
curl --location --request GET 'https://mvsep.com/api/app/queue'
| Kulcs | Érték |
|---|---|
| queue |
Különböző csomagok aktuális várólistáinak tömbjét tartalmazza:
|
| plan |
Az aktuális csomag aktuális várólistáját tartalmazza (regisztrált/prémium csomag lekéréséhez adja hozzá az api_token paramétert):
|
Ha információt szeretne kapni a demó szeparációról, GET-hívást kell indítania a következő URL-re:
https://mvsep.com/api/app/demo
| Mező | Típus | Leírás |
|---|---|---|
| start | Egész szám | (opcionális) Kezdőpont-eltolás, alapértelmezés szerint 0 (azaz a legfrissebbtől indul) |
| limit | Egész szám | (nem kötelező) A visszaadott találatok maximális száma, alapértelmezés szerint 10, maximum 20. |
| algorithm_id | Egész szám | Opcionális szeparációs típus azonosító. Ezzel egyetlen algoritmus által létrehozott demó szeparációkat adhat vissza. Az értékek megegyeznek a GET SEPARATION TYPES végpont render_id értékével. |
| options[FIELD] | Karakterlánc / Egész szám | Opcionális szűrő az algoritmusopciók értékéhez. Cserélje le a FIELD értéket egy további mezőkulccsal az algorithm_fields -> name mezőből a GET SEPARATION TYPES válaszban, majd adja át az adott mező egyik options kulcsát értékként. Példa: options[vocals]=1. |
| additional_options | Karakterlánc | Opcionális, raw tartalomszűrés a tárolt feladatbeállítás-adatok alapján. Új integrációkhoz inkább az options[FIELD] paramétert használja, mert egyértelműbb és könnyebben összeállítható. |
curl --location --request GET 'https://mvsep.com/api/app/demo?start=0&limit=2'
curl --location --request GET 'https://mvsep.com/api/app/demo?algorithm_id=20&options[vocals]=1&start=0&limit=10'
Opciószűrők összeállításához először hívja meg a https://mvsep.com/api/app/algorithms végpontot, és nézze át az egyes algoritmusok algorithm_fields listáját. A mező name értékét írja az options[FIELD] helyére, értékként pedig a JSON opciókulcsok egyikét adja meg.
Az adatokat tömbként adja vissza:
| Kulcs | Érték |
|---|---|
| hash | A szeparáció hash-e |
| date | A szeparáció dátuma |
| input_audio | A bemeneti hang URL-címe |
| size | Bemeneti hangméret |
| algorithm | Alapvető információkat tartalmaz a használt szeparációs típusról (a visszaadott paraméterekkel kapcsolatos információkért tekintse meg a SZEPARÁCIÓS TÍPUSOK LEKÉRÉSE fület) |
A felhasználó MVSEP oldalra történő regisztrálásához POST-hívást kell indítania a következő URL-re:
https://mvsep.com/api/app/register
| Mező | Típus | Leírás |
|---|---|---|
| name | Karakterlánc | A felhasználó neve |
| Karakterlánc | A felhasználó e-mail címe | |
| password | Karakterlánc | A felhasználó jelszava |
| password_confirmation | Karakterlánc | Ismételje 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ó hitelesítéséhez és a felhasználó API-kulcsának lekérdezéséhez POST-hívást kell indítania a következő URL-re:
https://mvsep.com/api/app/login
| Mező | Típus | Leírás |
|---|---|---|
| Karakterlánc | A felhasználó e-mail címe | |
| password | Karakterlánc | 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. Ügyeljen rá, hogy biztonságos helyen tárolja, és a további műveletekhez ezt használja. |
| 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ói adatok lekérdezéséhez GET-hívást kell indítania a következő URL-re:
https://mvsep.com/api/app/user
| Mező | Típus | Leírás |
|---|---|---|
| api_token | Karakterlánc | 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. Ügyeljen rá, hogy biztonságos helyen tárolja, és a további műveletekhez ezt használja. |
| 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ő szeparációkat 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 alapadatokat kapjon a felhasználó szeparációs előzményeiről, GET-hívást kell indítania a következő URL-re:
https://mvsep.com/api/app/separation_history
| Mező | Típus | Leírás |
|---|---|---|
| api_token | Karakterlánc | A felhasználó API kulcsa |
| start | Egész szám | (opcionális) Kezdőpont-eltolás, alapértelmezés szerint 0 (azaz a legfrissebbtől indul) |
| limit | Egész szám | (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 szeparációkról |
| data -> hash | A szeparáció hash-e |
| data -> job_exists | Alapvető információkat tartalmaz a korábbi szeparációkról |
| data -> credits | Hány kreditet használt fel a feladat; null, ha a szeparáció már nem létezik. |
| 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 szeparációs típusról (a visszaadott paraméterekkel kapcsolatos információkért tekintse meg a SZEPARÁCIÓS TÍPUSOK LEKÉRÉSE fület) |
Az MVSEP API a következő hibakódokat használja:
| Hibakód | Jelentése |
|---|---|
| 400 | Érvénytelen API kulcs |
Ahhoz, hogy lekérje ennek a fióknak a kreditvásárlásait – a legújabbal kezdve –, GET-hívást kell indítania a következő URL-re:
https://mvsep.com/api/purchases
| Mező | Típus | Leírás |
|---|---|---|
| api_token | Karakterlánc | A felhasználó API kulcsa |
| limit | Egész szám | (opcionális) Hány vásárlást adjon vissza, 1–100. Az alapértelmezett érték 20. |
| offset | Egész szám | (opcionális) Hány vásárlást kell kihagyni a vásárlási előzmények lapozásakor. Az alapértelmezett érték 0. |
| status | Karakterlánc | (opcionális) Csak az ebben az állapotban lévő vásárlásokat adja vissza, pl. succeeded. Hagyja ki (vagy adja meg a all értéket), hogy a weboldal saját előzményoldalán megjelenő összes adatot megkapja, beleértve azokat a fizetési folyamatokat is, amelyeket elindítottak, de soha nem fejeztek be — ezek állapota unpaid, és nem járnak hozzájuk kreditpontok. |
curl --location --request GET 'https://mvsep.com/api/purchases?api_token=<Az API-tokenje>&status=succeeded&limit=20'
| Kulcs | Érték |
|---|---|
| purchases | Vásárlásonként egy bejegyzés: payment_id, status, amount, a jóváírt credits, payment_method (stripe, paddle, yookassa, google_play vagy app_store) és date. |
| total | Összesen hány vásárlás felel meg a szűrésnek, a limit és az eltolás figyelmen kívül hagyásával — ez alapján lapozhat. |
| credits | A fiók aktuális kreditegyenlege. |
Az MVSEP e-mailt küld Önnek, amikor a kreditegyenlege az Ön által megadott küszöbértékre csökken, így a futó integráció nem áll le váratlanul. A GET parancs az aktuális beállítást adja vissza; a POST parancs pedig módosítja azt. A figyelmeztetés egyszer kerül elküldésre, és nem ismétlődik, amíg az egyenleg újra a küszöbérték fölé nem emelkedik.
GET https://mvsep.com/api/credit_alert
POST https://mvsep.com/api/credit_alert
| Mező | Típus | Leírás |
|---|---|---|
| api_token | Karakterlánc | A felhasználó API kulcsa |
| credit_threshold | Egész szám | (Csak POST, kötelező) A riasztást akkor küldje el, ha az egyenleg eléri vagy aláesik ennyi kredit értékét. 0 kikapcsolja a riasztást. A küszöbérték megváltoztatása újraaktiválja a már elküldött riasztást. |
curl --location --request GET 'https://mvsep.com/api/credit_alert?api_token=<Az API-tokenje>'
curl --location --request POST 'https://mvsep.com/api/credit_alert' --form 'api_token=<Az API-tokenje>' --form 'credit_threshold=100'
| Kulcs | Érték |
|---|---|
| credit_threshold | A jelenleg érvényben lévő küszöbérték, kreditben kifejezve. |
| enabled | <code>true</code>, ha nulla feletti küszöbértéket állítanak be, egyébként <code>false</code>. |
| credits | A fiók aktuális kreditegyenlege. |
| notified | <code>true</code> miután a rendszer riasztást küldött az aktuális esésről; automatikusan megszűnik, amikor az egyenleg újra a küszöbérték fölé emelkedik. |
| Az a cím, ahová a riasztás elküldésre kerül. |
A felhasználó prémiumhasználatának engedélyezéséhez POST-hívást kell indítania a következő URL-re:
https://mvsep.com/api/app/enable_premium
| Mező | Típus | Leírás |
|---|---|---|
| api_token | Karakterlánc | 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ítania a következő URL-re:
https://mvsep.com/api/app/disable_premium
| Mező | Típus | Leírás |
|---|---|---|
| api_token | Karakterlánc | 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 |
A hosszú fájlnevek engedélyezéséhez a felhasználó számára POST-hívást kell indítania a következő URL-re:
https://mvsep.com/api/app/enable_long_filenames
| Mező | Típus | Leírás |
|---|---|---|
| api_token | Karakterlánc | 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 |
A hosszú fájlnevek letiltásához a felhasználó számára POST-hívást kell indítania a következő URL-re:
https://mvsep.com/api/app/disable_long_filenames
| Mező | Típus | Leírás |
|---|---|---|
| api_token | Karakterlánc | 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 |
A Minőség-ellenőrző várólista bejegyzéseivel kapcsolatos információk lekéréséhez GET hívást kell kezdeményeznie a következő URL-címre:
https://mvsep.com/api/quality_checker/queue
| Mező | Típus | Leírás |
|---|---|---|
| start | Egész szám | (opcionális) Kezdőpont-eltolás, alapértelmezés szerint 0 (azaz a legfrissebbtől indul) |
| limit | Egész szám | (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 | Bejegyzés azonosító száma |
| dataset_type | A bejegyzés hozzáadásakor kiválasztott adathalmaz-típus, illetve a ranglista típusa
|
| date | A bejegyzés létrehozásának dátuma |
| algo_name | A használt szeparációs típus/algoritmus neve |
| main_text | A használt szeparációs típus/algoritmus leírása |
| proc | A feldolgozás állapota
|
| proc_remote_date | A feldolgozás dátumának időbélyegzője |
| msg | Sikeres művelet esetén „OK” értéket ad vissza, egyébként hibaüzenetet jelenít meg. |
| metrics | Információk a bejegyzés mutatóiról |
| sdr_* (wildcard) | A megfelelő stemek SDR-értéke |
| dataset_name | Az adathalmaz neve |
A Quality Checker ranglistáival kapcsolatos információk megszerzéséhez GET hívást kell kezdeményeznie a következő URL-címen:
https://mvsep.com/api/quality_checker/leaderboard
| Mező | Típus | Leírás |
|---|---|---|
| dataset_type | Karakterlánc | Adatkészlet típusa, ha nincs megadva, alapértelmezett értéke 0.
|
| start | Egész szám | (opcionális) Kezdőpont-eltolás, alapértelmezés szerint 0 (azaz a legfrissebbtől indul) |
| limit | Egész szám | (nem kötelező) A visszaadott találatok maximális száma, alapértelmezés szerint 10, maximum 20. |
| algo_name_filter | Karakterlánc | A megadott szöveg alapján szűri a szeparációs típus/algoritmus nevét |
| sort | Karakterlánc | Rendezés az adott stem SDR-értéke szerint. Az adott adathalmaz-típushoz rendezésre használható értékek listáját a válasz sortables kulcsa tartalmazza. |
curl --location --request GET 'https://mvsep.com/api/quality_checker/leaderboard?&start=1&limit=2&algo_name_filter=MVSep'
| Kulcs | Érték |
|---|---|
| data | Minőség-ellenőrző bejegyzések tömbjét tartalmazza. További információért lásd a Minőség-ellenőrző szakasz GET QUEUE válaszát. |
| dataset_type | Használt adatkészlet-típuskulcs |
| sortables | Azok a kulcsok, amelyekkel a használt adathalmaz-típus egy adott stem szerint, növekvő sorrendben rendezhető. |
| sort | A rendezhető kulcsok közül ténylegesen használt rendezési kulcs. |
Minőség-ellenőrző bejegyzés létrehozásához POST hívást kell kezdeményezni a következő URL-címre:
https://mvsep.com/api/quality_checker/add
| Mező | Típus | Leírás |
|---|---|---|
| api_token | Karakterlánc | (kötelező) Az Ön API-kulcsa |
| zipfile | Bináris | (kötelező) Feldolgozandó zip fájl |
| algo_name | Karakterlánc | (kötelező) Az algoritmus neve |
| main_text | Karakterlánc | (kötelező) Az algoritmus leírása |
| dataset_type | Karakterlánc | Adatkészlet típusa. Alapértelmezés szerint 0.
|
| password | Karakterlánc | (kötelező) Jelszó az algoritmus törléséhez |
| ensemble | Egész szám | 0 – az algoritmus nem ensemble. 1 – az algoritmus 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 | Információkat tartalmaz a bejegyzésről |
| data -> id | a bejegyzés azonosítója |
| data -> link | Link a bejegyzéshez |
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
|
A Minőség-ellenőrző várólistájának egy bejegyzéséről azonosító alapján történő információszerzéshez GET-hívást kell kezdeményeznie a következő URL-címre:
https://mvsep.com/api/quality_checker/entry
| Mező | Típus | Leírás |
|---|---|---|
| id | Egész szám | (kötelező) a bejegyzés azonosítója |
curl --location --request GET 'https://mvsep.com/api/quality_checker/entry?id=7675'
A Minőség-ellenőrző várólistája egy bejegyzésének azonosító és jelszó alapján történő törléséhez GET-hívást kell kezdeményeznie a következő URL-címre:
https://mvsep.com/api/quality_checker/delete
| Mező | Típus | Leírás |
|---|---|---|
| id | Egész szám | (kötelező) a bejegyzés azonosítója |
| password | Karakterlánc | (kötelező) A bejegyzéshez használt jelszó |
curl --location 'https://mvsep.com/api/quality_checker/delete' --form 'id="7720"' --form 'password="test"'
| Kulcs | Érték |
|---|---|
| success |
|
| data->message | Megjeleníti, hogy a bejegyzés törölve lett-e |
Az ezen API-ra épülő könyvtárak, alkalmazások és integrációk. Külön jelölés hiányában ezek közösségi projektek: karbantartásuk nem az MVSEP feladata, és nem vállalunk értük felelősséget.
Ez a program a PyPI-n mvsep-cli néven érhető el, és szerzőjeként az MVSEP-et jelöli meg, ami miatt hivatalosnak tűnhet. A programot azonban nem az MVSEP, hanem egy harmadik fél tette közzé és tartja karban, és a hivatkozott forráskód-tárhely nem létezik. A program bekéri az API-tokenjét, ezért mielőtt beilleszti a tokent, mindenképpen olvassa el a forráskódját.
mvsep-cli: pypi.org/project/mvsep-cli
