turbo@mvsep.com
MVSEP API, tahlil yaratishga, natijalarni qaytarishga, sayt ma'lumotlarini olishga va foydalanuvchi imkoniyatlarini boshqarishga dasturiy kirish imkonini beradi
Ushbu API-dan foydalanish uchun sizga API kalitikerak. Siz tizimga kirmagansiz, API tokeningizni olish uchun iltimos, tizimga kiring
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
Premium foydalanuvchilari bir vaqtda 10 ish hosil qilishi mumkinligini unutmang, non-Premium foydalanuvchilari esa faqat bir vaqtda 1 ish hosil qilishi.
Ajratish yaratish uchun quyidagi URL manziliga POST qo’ng’irog’i qilishingiz kerak:
https://mvsep.com/api/separation/create
| Maydon | Tur | Tavsif |
|---|---|---|
| api_token | String | Sizning API kalitingiz |
| audiofile | Binary | Qayta ishlanishi kerak bo’lgan audio fayl. Not required if url parameter is set |
| url | String | Link to the audiofile. Not required if audiofile parameter is set |
| remote_type | String | (optional) Remote type of the audiofile. Defaults to direct. Not required if audiofile parameter is set. Supported types are direct (Direct Download), mega (MEGA), drive (Google Drive), dropbox (Dropbox) |
| sep_type | Integer | (ixtiyoriy) Ajratish turi, standart holda 11 (Demucs3 Model B (vocals, drums, bass, other)) |
| add_opt1 | String | (ixtiyoriy) Ajratish turi birinchi qo’shimcha maydon |
| add_opt2 | String | (ixtiyoriy) ajratish turi ikkinchi qo'shimcha maydon |
| add_opt3 | String | (ixtiyoriy) Tahlil turi uchinchi qo'shimcha maydoni |
| output_format | Integer | (ixtiyoriy) chiqish format, 0 uchun standartni (mp3 (320kbps)) |
| is_demo | Boolean | (ixtiyoriy) ajratish demo sahifaga chop kerak, false uchun standartni |
| Ism | Qiymat | Additional fields |
|---|---|---|
| Ensemble (vocals, instrum) | 26 | Key: add_opt1 Name: Output files Options:
Key: add_opt2 Name: Model Type Options:
|
| Ensemble (vocals, instrum, bass, drums, other) | 28 | Key: add_opt1 Name: Output files Options:
Key: add_opt2 Name: Model Type Options:
|
| Ensemble All-In (vocals, bass, drums, piano, guitar, lead/back vocals, other) | 30 | Key: add_opt1 Name: Output files Options:
Key: add_opt2 Name: Model Type Options:
|
| BS Roformer SW (vocals, bass, drums, guitar, piano, other) | 63 | |
| BS Roformer (vocals, instrumental) | 40 | Key: add_opt1 Name: Vocal model type Options:
|
| MelBand Roformer (vocals, instrumental) | 48 | Key: add_opt1 Name: Vocal model type Options:
|
| MDX23C (vocals, instrumental) | 25 | Key: add_opt1 Name: Vocal model type Options:
|
| SCNet (vocals, instrumental) | 46 | Key: add_opt1 Name: Vocal model type Options:
|
| Demucs4 HT (vocals, drums, bass, other) | 20 | Key: add_opt1 Name: Model type Options:
|
| MDX B (vocals, instrumental) | 23 | Key: add_opt1 Name: Vocal model type Options:
|
| Ultimate Vocal Remover VR (vocals, music) | 9 | Key: add_opt1 Name: Model Type Options:
Key: add_opt2 Name: Agressiveness Options:
|
| Demucs4 Vocals 2023 (vocals, instrum) | 27 | |
| 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 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 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 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 Strings (strings, other) | 52 | Key: add_opt1 Name: String model type Options:
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 Organ (organ, other) | 58 | Key: add_opt1 Name: Organ model type Options:
|
| MVSep Saxophone (saxophone, other) | 61 | Key: add_opt1 Name: Model type Options:
|
| MVSep Flute (flute, other) | 67 | Key: add_opt1 Name: Flute 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 Harp (harp, other) | 72 | |
| MVSep Mandolin (mandolin, other) | 74 | |
| 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 Tambourine (tambourine, other) | 76 | |
| 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:
|
| 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:
|
| MVSep Crowd removal (crowd, other) | 34 | Key: add_opt1 Name: Model type 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:
|
| DrumSep (4-6 stems: kick, snare, cymbals, toms, ride, hh, crash) | 37 | Key: add_opt1 Name: Model Type Options:
Key: add_opt2 Name: Preprocess Options:
|
| DeNoise by aufr33 | 47 | Key: add_opt1 Name: Model type Options:
|
| Whisper (extract text from audio) | 39 | Key: add_opt1 Name: Model type Options:
Key: add_opt2 Name: Transcription type Options:
|
| Parakeet (extract text from audio) | 64 | Key: add_opt1 Name: Model type Options:
|
| Medley Vox (Multi-singer separation) | 53 | Key: add_opt1 Name: Model type Options:
|
| MVSep Multichannel BS (vocals, instrumental) | 43 | Key: add_opt1 Name: Model Type Options:
|
| MVSep Male/Female separation | 57 | Key: add_opt1 Name: Model type Options:
Key: add_opt2 Name: How to extract Options:
|
| 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:
|
| Stable Audio Open Gen | 62 | Key: add_opt1 Name: Text prompt Options: Key: add_opt2 Name: Length (in seconds) Options:
|
| MVSep MultiSpeaker (MDX23C) | 42 | Key: add_opt1 Name: Model Type Options:
|
| Aspiration (by Sucial) | 50 | Key: add_opt1 Name: Model type Options:
|
| AudioSR (Super Resolution) | 59 | Key: add_opt1 Name: Cutoff (Hz) Options:
|
| Phantom Centre extraction (by wesleyr36) | 55 | |
| FlashSR (Super Resolution) | 60 | |
| Matchering (by sergree) | 68 |
| Ism | Qiymat |
|---|---|
| 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="<Sizning API Tokeningiz>"'
--form 'sep_type="9"'
--form 'add_opt1="0"'
--form 'add_opt2="1"'
--form 'output_format="1"'
--form 'is_demo="1"'
| Kalit | Qiymat |
|---|---|
| success |
|
| data | success kalitiga bog'liq qo'shimcha ma'lumotlarni saqlaydi |
| data -> link | Yaratilgan ishning "GET RESULT" URL manziliga havola ko'rsatadi (faqat success true bo'lganda ko'rsatiladi) |
| data -> hash | Yaratilgan ishning xeshini ko'rsatadi (faqat success true bo'lganda ko'rsatiladi) |
| data -> message | Xato tavsifini ko'rsatadi (faqat success false bo'lganda ko'rsatiladi) |
MVSEP API quyidagi xato kodlaridan foydalanadi:
| Xato Kodi | Ma'nosi |
|---|---|
| 400 | Ba'zi parametrlar yo'q yoki yaroqsiz. Ushbu xato har bir majburiy parametrlardan o'tmasangiz yoki noto'g'ri parametrlardan o'tmasangiz paydo bo'ladi. |
| 401 |
Noma'lum yoki yaroqsiz api_token. Agar noma'lum API kalitidan foydalansangiz, bu xato paydo bo'ladi.
|
Ajratish natijasini olish uchun siz quyidagi url manziliga GET murojaatini yuborishingiz kerak:
https://mvsep.com/api/separation/get
| Maydon | Tur | Tavsif |
|---|---|---|
| hash | String | Ajratish Xeshi |
| mirror | Integer | (ixtiyoriy) 1 ga o'rnatilgan bo'lsa boshqa ko'zguni ishlatadi, standart 0. 1 ga o'rnatilsa api_token va 1 kredit talab etiladi |
| api_token | string | (ixtiyoriy) Foydalanuvchining API kaliti. Agar ko'zgular parametri 1 ga o'rnatilgan bo'lsa, talab etiladi |
curl --location --request GET 'https://mvsep.com/api/separation/get?hash=20230327071601-0e3e5c6c85-13-dimensions.mp3'
| Kalit | Qiymat |
|---|---|
| success |
|
| status |
|
| data | status kalitiga bog'liq qo'shimcha ma'lumotlarni saqlaydi |
| data -> queue_count | Foydalanuvchining ustuvorliklarida qayta ishlanmagan ishlar sonini ko'rsatadi (faqat status waiting yoki distributing bo'lganda ko'rsatiladi) |
| data -> current_order | Foydalanuvchining ish tartibini ko'rsatadi (faqat status waiting yoki distributing bo'lganda ko'rsatiladi) |
| data -> message | Status tavsifini ko'rsatadi (barcha statuslarda ko'rsatiladi, status failed bo'lsa xato sababini ko'rsatadi) |
| data -> algorithm | Ishda ishlatilgan algoritmni ko'rsatadi (faqat status done bo'lganda ko'rsatiladi) |
| data -> algorithm_description | Ishda ishlatilgan algoritm tafsilotlarini ko'rsatadi (faqat status done bo'lganda ko'rsatiladi) |
| data -> output_format | Ishning chiqish formatini ko'rsatadi (faqat status done bo'lganda ko'rsatiladi) |
| data -> tags | Audio meta teglarini ko'rsatadi (faqat status done bo'lganda ko'rsatiladi) |
| data -> input_file | Kirish audio yuklab olish tafsilotlarini ko'rsatadi (faqat status done bo'lganda ko'rsatiladi) |
| data -> files | Chiqish audio yuklab olish tafsilotlarini ko'rsatadi (faqat status done bo'lganda ko'rsatiladi) |
| data -> date | Ish qayta ishlash sanasini ko'rsatadi (faqat status done bo'lganda ko'rsatiladi) |
| data -> finished_chunks | Katta ishning tugallangan qismlari sonini ko'rsatadi (faqat status distributing bo'lganda ko'rsatiladi) |
| data -> all_chunks | Katta ishning barcha qismlari sonini ko'rsatadi (faqat status distributing bo'lganda ko'rsatiladi) |
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
| Maydon | Tur | Tavsif |
|---|---|---|
| hash | String | Ajratish Xeshi |
curl --location --request GET 'https://mvsep.com/api/separation/get-remote?hash=n2AwBjy4KsFZfqqR'
| Kalit | Qiymat |
|---|---|
| success |
|
| status |
|
| data | status kalitiga bog'liq qo'shimcha ma'lumotlarni saqlaydi |
| 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
| Maydon | Tur | Tavsif |
|---|---|---|
| api_token | string | Foydalanuvchi API kaliti |
| hash | string | Ajratish Xeshi |
curl --location --request POST 'https://mvsep.com/api/separation/cancel' --form 'api_token="<Sizning API Tokeningiz>"' --form 'hash="<hash>"'
| Kalit | Qiymat |
|---|---|
| success |
|
Tahlil turlari haqidagi batafsil ma'lumotlarni olish uchun quyidagi URL manziliga GET chaqiruvi amalga oshirishingiz kerak:
https://mvsep.com/api/app/algorithms
curl --location --request GET 'https://mvsep.com/api/app/algorithms'
Ma'lumotlar massivi sifatida qaytariladi:
| Kalit | Qiymat |
|---|---|
| render_id | Tahlil turi qiymati (ID) |
| name | Tahlil turi nomi |
| algorithm_group_id |
Tahlil turi qaysi guruhga tegishli:
|
| orientation |
Ushbu tahlil turi kim uchun mo'ljallangan:
|
| order_id | Tahlil turi tartibi |
| price_coefficient |
Premium foydalanuvchidan ish qanchalik kredit talab qilinadi hisoblash uchun ishlatiladi Ushbu formula ishlatiladi : floor(<audiofayl davomiyligi soniyalarda> * price_coefficient / 60)?:1
|
| usage | Shows monthly usage count of separation type |
| rating | Shows monthly usage rating of separation type as array:
|
| algorithm_fields | Tahlil turi qo'shimcha maydonlari haqidagi ma'lumotlarni o'z ichiga oladi |
| algorithm_fields -> name |
Qaysi qo'shimcha maydon tahlil turidan ko'rsatiladi:
|
| algorithm_fields -> text | Tahlil turining qo'shimcha maydonining ko'rsatilgan nomi |
| algorithm_fields -> options | Qo'shimcha maydon uchun JSON formatidagi kalit-qiymat zanjirlar |
| algorithm_fields -> default_key | Qo'shimcha maydonning standart qiymati. <code>algorithm_fields -> options</code> kalitlaridan biri |
| algorithm_descriptions | Tahlil turi tavsiflari haqidagi ma'lumotlarni o'z ichiga oladi |
| algorithm_descriptions -> short_description | HTML ishlatmaydigan tahlil turi haqida qisqa tavsif |
| algorithm_descriptions -> long_description | HTML ishlatadigan tahlil turi haqida batafsil tavsif |
| algorithm_descriptions -> lang | Tavsifning belgilangan til kodi |
MVSEP haqidagi yangiliklarni olish uchun quyidagi URL manziliga GET chaqiruvi amalga oshirishingiz kerak:
https://mvsep.com/api/app/news
| Maydon | Tur | Tavsif |
|---|---|---|
| lang | String | (ixtiyoriy) 2-harfli til kodi (en, ru) |
| start | Integer | (ixtiyoriy) Boshlang'ich nuqta, odatiy qiymati 0 (ya'ni eng so'nggi yangilikdan boshlash) |
| limit | Integer | (ixtiyoriy) Qaytariladigan natijalar maksimal miqdori, odatiy qiymati 10, maksimal 20. |
curl --location --request GET 'https://mvsep.com/api/app/news?lang=en&start=2&limit=1'
Ma'lumotlar massivi sifatida qaytariladi:
| Kalit | Qiymat |
|---|---|
| title | Yangilikning sarlavhasi |
| lang | Yangilikning sarlavhasi |
| text | Yangilikning to'liq ta'rifi |
| created_at | Yangilik sanasi |
To get site queue information, you need to make a GET call to the following url:
https://mvsep.com/api/app/queue
| Maydon | Tur | Tavsif |
|---|---|---|
| api_token | String | (optional) Foydalanuvchi API kaliti |
curl --location --request GET 'https://mvsep.com/api/app/queue'
| Kalit | Qiymat |
|---|---|
| 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):
|
Demo ajratmalar haqida ma'lumot olish uchun quyidagi URL manziliga GET so'rovi yuborishingiz kerak:
https://mvsep.com/api/app/demo
| Maydon | Tur | Tavsif |
|---|---|---|
| start | Integer | (ixtiyoriy) Boshlang'ich nuqta, odatiy qiymati 0 (ya'ni eng so'nggi yangilikdan boshlash) |
| limit | Integer | (ixtiyoriy) Qaytariladigan natijalar maksimal miqdori, odatiy qiymati 10, maksimal 20. |
curl --location --request GET 'https://mvsep.com/api/app/demo?start=0&limit=2'
Ma'lumotlar massivi sifatida qaytariladi:
| Kalit | Qiymat |
|---|---|
| hash | Ajratish Xeshi |
| date | Ajratma sanasi |
| input_audio | Kirish audio URL manzili |
| size | Kirish audio hajmi |
| algorithm | Foydalanilgan ajratma turiga oid asosiy ma'lumotlarni o'z ichiga oladi (qaytarilgan parametrlar haqida ma'lumot uchun GET SEPARATION TYPES bo'limiga qarang) |
Foydalanuvchini autentifikatsiya qilish va uning API kalitini olish uchun quyidagi URL manziliga POST so'rovi yuborishingiz kerak:
https://mvsep.com/api/app/login
| Maydon | Tur | Tavsif |
|---|---|---|
| String | Foydalanuvchining elektron pochta manzili | |
| password | String | Foydalanuvchining paroli |
curl --location --request POST 'https://mvsep.com/api/app/login' --form 'email="<Foydalanuvchining elektron pochta manzili>"' --form 'password="<Foydalanuvchining paroli>"'
| Kalit | Qiymat |
|---|---|
| success |
|
| data | Ma'lumotlar to'g'ri bo'lsa, ma'lumotlarni o'z ichiga oladi |
| data -> name | Foydalanuvchining ismi |
| data -> email | Foydalanuvchining elektron pochta manzili |
| data -> api_token | Foydalanuvchi API kaliti. Uni xavfsiz joyda saqlang va keyingi operatsiyalar uchun foydalaning. |
| data -> premium_minutes | Foydalanuvchida qolgan kreditlar |
| data -> premium_enabled |
Foydalanuvchi kreditlaridan foydalanishga ruxsat berganmi:
|
| data -> long_filenames_enabled |
Foydalanuvchi fayl nomlarida qo'shimcha ma'lumotlarni ko'rsatishni xohlaysizmi:
|
MVSEP API quyidagi xato kodlaridan foydalanadi:
| Xato Kodi | Ma'nosi |
|---|---|
| 400 | Noto'g'ri ma'lumotlar kiritilganda xato yuzaga keladi |
Foydalanuvchini MVSEP saytiga ro'yxatdan o'tkazish uchun quyidagi URL manziliga POST so'rovi yuborishingiz kerak:
https://mvsep.com/api/app/register
| Maydon | Tur | Tavsif |
|---|---|---|
| name | String | Foydalanuvchining ismi |
| String | Foydalanuvchining elektron pochta manzili | |
| password | String | Foydalanuvchining paroli |
| password_confirmation | String | Foydalanuvchining parolini qayta kiriting |
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"'
| Kalit | Qiymat |
|---|---|
| success |
|
| message | Forma noto'g'ri bo'lsa, xato yuzaga keladi |
MVSEP API quyidagi xato kodlaridan foydalanadi:
| Xato Kodi | Ma'nosi |
|---|---|
| 400 | Forma yaroqsiz |
Foydalanuvchi haqida ma'lumot olish uchun quyidagi URL-ga GET so'rovini yuborishingiz kerak:
https://mvsep.com/api/app/user
| Maydon | Tur | Tavsif |
|---|---|---|
| api_token | String | Foydalanuvchi API kaliti |
curl --location --request GET 'https://mvsep.com/api/app/user?api_token=<Sizning API Tokeningiz>'
| Kalit | Qiymat |
|---|---|
| success |
|
| data | Ma'lumotlar to'g'ri bo'lsa, ma'lumotlarni o'z ichiga oladi |
| data -> name | Foydalanuvchining ismi |
| data -> email | Foydalanuvchining elektron pochta manzili |
| data -> api_token | Foydalanuvchi API kaliti. Uni xavfsiz joyda saqlang va keyingi operatsiyalar uchun foydalaning. |
| data -> premium_minutes | Foydalanuvchida qolgan kreditlar |
| data -> premium_enabled |
Foydalanuvchi kreditlaridan foydalanishga ruxsat berganmi:
|
| data -> long_filenames_enabled |
Foydalanuvchi fayl nomlarida qo'shimcha ma'lumotlarni ko'rsatishni xohlaysizmi:
|
| data -> current_queue | Foydalanuvchining davom etayotgan ajratmalarini ko'rsatadi |
MVSEP API quyidagi xato kodlaridan foydalanadi:
| Xato Kodi | Ma'nosi |
|---|---|
| 400 | Yaroqsiz API kaliti |
Foydalanuvchining ajratish tarixining asosiy ma'lumotlarini olish uchun quyidagi URL-ga GET so'rovini yuborishingiz kerak:
https://mvsep.com/api/app/separation_history
| Maydon | Tur | Tavsif |
|---|---|---|
| api_token | String | Foydalanuvchi API kaliti |
| start | Integer | (ixtiyoriy) Boshlang'ich nuqta, odatiy qiymati 0 (ya'ni eng so'nggi yangilikdan boshlash) |
| limit | Integer | (ixtiyoriy) Qaytariladigan natijalar maksimal miqdori, odatiy qiymati 10, maksimal 20. |
curl --location --request GET 'https://mvsep.com/api/app/separation_history?api_token=<Sizning API Tokeningiz>&start=1&limit=2'
| Kalit | Qiymat |
|---|---|
| success |
|
| data | Oldingi ajratishlar haqida asosiy ma'lumotlar ro'yxatini o'z ichiga oladi |
| data -> hash | Ajratish Xeshi |
| data -> job_exists | Oldingi ajratishlar haqida asosiy ma'lumotlar ro'yxatini o'z ichiga oladi |
| data -> credits | Ish uchun qancha kredit sarflangani, agar ajratish mavjud bo'lmasa null bo'ladi |
| data -> time_left | Ish o'chirilishiga qadar taxminiy vaqt |
| data -> algorithm | Foydalanilgan ajratma turiga oid asosiy ma'lumotlarni o'z ichiga oladi (qaytarilgan parametrlar haqida ma'lumot uchun GET SEPARATION TYPES bo'limiga qarang) |
MVSEP API quyidagi xato kodlaridan foydalanadi:
| Xato Kodi | Ma'nosi |
|---|---|
| 400 | Yaroqsiz API kaliti |
Foydalanuvchi uchun premium foydalanishni yoqish uchun quyidagi URL-ga POST so'rovini yuborishingiz kerak:
https://mvsep.com/api/app/enable_premium
| Maydon | Tur | Tavsif |
|---|---|---|
| api_token | String | Foydalanuvchi API kaliti |
curl --location --request POST 'https://mvsep.com/api/app/enable_premium' --form 'api_token="<Sizning API Tokeningiz>"'
| Kalit | Qiymat |
|---|---|
| success |
|
| message | Amaliyot holati haqida xabar beradi |
MVSEP API quyidagi xato kodlaridan foydalanadi:
| Xato Kodi | Ma'nosi |
|---|---|
| 400 | Yaroqsiz API kaliti |
Foydalanuvchi uchun premium foydalanishni o'chirish uchun quyidagi URL-ga POST so'rovini yuborishingiz kerak:
https://mvsep.com/api/app/disable_premium
| Maydon | Tur | Tavsif |
|---|---|---|
| api_token | String | Foydalanuvchi API kaliti |
curl --location --request POST 'https://mvsep.com/api/app/disable_premium' --form 'api_token="<Sizning API Tokeningiz>"'
| Kalit | Qiymat |
|---|---|
| success |
|
| message | Amaliyot holati haqida xabar beradi |
MVSEP API quyidagi xato kodlaridan foydalanadi:
| Xato Kodi | Ma'nosi |
|---|---|
| 400 | Yaroqsiz API kaliti |
Foydalanuvchi uchun uzun fayl nomlarini yoqish uchun quyidagi URL-ga POST so'rovini yuborishingiz kerak:
https://mvsep.com/api/app/enable_long_filenames
| Maydon | Tur | Tavsif |
|---|---|---|
| api_token | String | Foydalanuvchi API kaliti |
curl --location --request POST 'https://mvsep.com/api/app/enable_long_filenames' --form 'api_token="<Sizning API Tokeningiz>"'
| Kalit | Qiymat |
|---|---|
| success |
|
| message | Amaliyot holati haqida xabar beradi |
MVSEP API quyidagi xato kodlaridan foydalanadi:
| Xato Kodi | Ma'nosi |
|---|---|
| 400 | Yaroqsiz API kaliti |
Foydalanuvchi uchun uzun fayl nomlarini o'chirish uchun quyidagi URL-ga POST so'rovini yuborishingiz kerak:
https://mvsep.com/api/app/disable_long_filenames
| Maydon | Tur | Tavsif |
|---|---|---|
| api_token | String | Foydalanuvchi API kaliti |
curl --location --request POST 'https://mvsep.com/api/app/disable_long_filenames' --form 'api_token="<Sizning API Tokeningiz>"'
| Kalit | Qiymat |
|---|---|
| success |
|
| message | Amaliyot holati haqida xabar beradi |
MVSEP API quyidagi xato kodlaridan foydalanadi:
| Xato Kodi | Ma'nosi |
|---|---|
| 400 | Yaroqsiz API kaliti |
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
| Maydon | Tur | Tavsif |
|---|---|---|
| start | Integer | (ixtiyoriy) Boshlang'ich nuqta, odatiy qiymati 0 (ya'ni eng so'nggi yangilikdan boshlash) |
| limit | Integer | (ixtiyoriy) Qaytariladigan natijalar maksimal miqdori, odatiy qiymati 10, maksimal 20. |
curl --location --request GET 'https://mvsep.com/api/quality_checker/queue?&start=1&limit=2'
Ma'lumotlar massivi sifatida qaytariladi:
| Kalit | Qiymat |
|---|---|
| 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
| Maydon | Tur | Tavsif |
|---|---|---|
| dataset_type | String | Dataset Type, defaults to 0 if not given
|
| start | Integer | (ixtiyoriy) Boshlang'ich nuqta, odatiy qiymati 0 (ya'ni eng so'nggi yangilikdan boshlash) |
| limit | Integer | (ixtiyoriy) Qaytariladigan natijalar maksimal miqdori, odatiy qiymati 10, maksimal 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'
| Kalit | Qiymat |
|---|---|
| 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
| Maydon | Tur | Tavsif |
|---|---|---|
| api_token | String | (required) Sizning API kalitingiz |
| 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"'
| Kalit | Qiymat |
|---|---|
| success |
|
| data | Contains information about entry |
| data -> id | ID of the entry. |
| data -> link | Link to the entry. |
MVSEP API quyidagi xato kodlaridan foydalanadi:
| Xato Kodi | Ma'nosi |
|---|---|
| 400 | Forma yaroqsiz |
| 401 |
Noma'lum yoki yaroqsiz api_token. Agar noma'lum API kalitidan foydalansangiz, bu xato paydo bo'ladi.
|
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
| Maydon | Tur | Tavsif |
|---|---|---|
| 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
| Maydon | Tur | Tavsif |
|---|---|---|
| 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"'
| Kalit | Qiymat |
|---|---|
| success |
|
| data->message | Shows whether entry was deleted |
turbo@mvsep.com