turbo@mvsep.com
Информация за сайта
Често задавани въпроси
Проверка на качеството
Алгоритми
Пълна документация на API
MVSEP API предоставя програмно достъп до създаване на разделяне, връщане на резултати, получаване на информация за сайта и управление на потребителски способности.
За да използвате този API, се нуждаете от API ключ. Не сте влезли, моля, влезте, за да получите вашия API токен.
Examples in Python: https://github.com/ZFTurbo/MVSep-API-Examples
Unofficial application MacVSep for Mac OS: https://github.com/septcoco/macvsep
Webhooks can be setup here: Webhooks Page
OpenAPI Specification: mvsep-openapi-spec.json
Note that Premium users can request unlimited concurrent jobs, while non-Premium users can only request 1 concurrent job.
За да създадете разделяне е необходимо да последвате следния линк:
https://mvsep.com/api/separation/create
| Неуспешен опит | Вид | Описание |
|---|---|---|
| api_token | String | Вашият API ключ |
| audiofile | Binary | Аудио файл за разработка. 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 | (optional) Вид на разделянето, 11 по подразбиране (Demucs3 Model B (вокали, барабани, бас, други)) |
| add_opt1 | String | (optional) Разделителен Вид първо допълнително поле |
| add_opt2 | String | (optional) Разделителен Вид второ допълнително поле |
| add_opt3 | String | (по избор) Тип разделяне на трето допълнително поле |
| output_format | Integer | (optional) изходен формат, по подразбиране 0 (mp3 (320kbps)) |
| is_demo | Boolean | (optional) да се публикува ли разделеният проект на демо страницата, изключено по подразбиране |
| Име | Стойност | 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:
|
| Име | Стойност |
|---|---|
| mp3 (320 kbps) | 0 |
| wav (uncompressed, 16 bit) | 1 |
| flac (lossless, 16 bit) | 2 |
| m4a (lossy) | 3 |
| wav (uncompressed, 32 bit) | 4 |
| flac (lossless, 24 bit) | 5 |
curl --location --request POST 'https://mvsep.com/api/separation/create'
--form 'audiofile=@"/path/to/file.mp3"'
--form 'api_token="<Вашият API токен>"'
--form 'sep_type="9"'
--form 'add_opt1="0"'
--form 'add_opt2="1"'
--form 'output_format="1"'
--form 'is_demo="1"'
| Ключ | Стойност |
|---|---|
| success |
|
| data | Съхранява допълнителна информация в зависимост от ключа „success“. |
| data -> link | Показва връзка към URL адреса „GET RESULT“ на създадената задача (показва се само когато success is true) |
| data -> hash | Displays the created job hash (показва се само когато success is true) |
| data -> message | Показва описанието на дадена грешка (показва се само когато success is false) |
MVSEP API използва следният код за наизправност:
| Код за неизправност | Значение |
|---|---|
| 400 | Някои параметри липсват или са невалидни. Тази грешка се появява, когато не подадете всички задължителни параметри или подадените параметри са невалидни. |
| 401 |
Неизвестен или невалиден api_token. Тази грешка се появява ако сте използвали неизвестен API ключ
|
За да получите своя резултат е необходимо да последвате следния линк:
https://mvsep.com/api/separation/get
| Неуспешен опит | Вид | Описание |
|---|---|---|
| hash | String | Хеш за разделяне |
| mirror | Integer | (по избор) Използва друго огледало, ако е зададено на 1, по подразбиране е 0. Изисква api_token и 1 кредит, ако е зададено на 1. |
| api_token | string | (по избор) API ключ на потребителя. Задължително, ако параметърът mirror е зададен на 1. |
curl --location --request GET 'https://mvsep.com/api/separation/get?hash=20230327071601-0e3e5c6c85-13-dimensions.mp3'
| Ключ | Стойност |
|---|---|
| success |
|
| status |
|
| data | Съдържа допълнителна информация в зависимост от ключа status |
| data -> queue_count | Показва броя на необработените задачи в приоритета на потребителя (показва се само когато status е waiting или distributing) |
| data -> current_order | Показва реда на задачата на потребителя (показва се само когато status е waiting или distributing) |
| data -> message | Показва описанието на статуса (показва се при всички статуси, показва причината за грешка, когато status е failed) |
| data -> algorithm | Показва използвания алгоритъм за задачата (показва се само когато status е done) |
| data -> algorithm_description | Показва детайли за използвания алгоритъм за задачата (показва се само когато status е done) |
| data -> output_format | Показва изходния формат на задачата (показва се само когато status е done) |
| data -> tags | Показва мета таговете на аудиото (показва се само когато status е done) |
| data -> input_file | Показва детайли за изтегляне на входното аудио (показва се само когато status е done) |
| data -> files | Показва детайли за изтегляне на изходните аудиофайлове (показва се само когато status е done) |
| data -> date | Показва датата на обработка на задачата (показва се само когато status е done) |
| data -> finished_chunks | Показва броя на завършените части от голямата задача (показва се само когато status е distributing) |
| data -> all_chunks | Показва броя на всички части от голямата задача (показва се само когато status е distributing) |
To get the result of remote job, you need to make a GET call to the following url:
https://mvsep.com/api/separation/get-remote
| Неуспешен опит | Вид | Описание |
|---|---|---|
| hash | String | Хеш за разделяне |
curl --location --request GET 'https://mvsep.com/api/separation/get-remote?hash=n2AwBjy4KsFZfqqR'
| Ключ | Стойност |
|---|---|
| success |
|
| status |
|
| data | Съдържа допълнителна информация в зависимост от ключа status |
| data -> queue_count | Shows unprocessed jobs count in user's priority (only shown when status is waiting) |
| data -> current_order | Shows the order of user's job (only shown when status is waiting) |
| data -> message | Shows the description of status (only when status is failed) |
| data -> link | Shows link to "GET RESULT" URL of created job (only shown when status is done) |
| data -> hash | Hash of the separation (only shown when status is done) |
To cancel the separation and refund used credits (if the separation is not being processed yet), you need to make a POST call to the following url:
https://mvsep.com/api/separation/cancel
| Неуспешен опит | Вид | Описание |
|---|---|---|
| api_token | string | API ключ на потребителя |
| hash | string | Хеш за разделяне |
curl --location --request POST 'https://mvsep.com/api/separation/cancel' --form 'api_token="<Вашият API токен>"' --form 'hash="<hash>"'
| Ключ | Стойност |
|---|---|
| success |
|
За да получите подробни данни за типове разделяне, трябва да извършите GET заявка към следния URL:
https://mvsep.com/api/app/algorithms
| Неуспешен опит | Вид | Описание |
|---|---|---|
| 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'
Връща данни като масив:
| Ключ | Стойност |
|---|---|
| render_id | Стойност на типа разделяне (ID) |
| name | Името на типа разделяне |
| algorithm_group_id | Групата, към която принадлежи типът разделяне: |
| 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 |
За кого е предназначен този тип разделяне:
|
| order_id | Редът на типа разделяне |
| price_coefficient |
Използва се за изчисляване на колко кредити ще отнеме задачата от премиум потребителя. Използва следната формула : floor(<продължителност на аудиофайла в секунди> * price_coefficient / 60)?:1
|
| usage | Shows monthly usage count of separation type |
| rating | Shows monthly usage rating of separation type as array:
|
| algorithm_fields | Ще трябва да изпратите разделяне с това име, за да изберете правилното допълнително поле. |
| algorithm_fields -> name |
Показва кое допълнително поле на типа разделяне:
|
| algorithm_fields -> text | Показване на името на допълнителното поле на типа разделяне. |
| algorithm_fields -> options | JSON кодирани ключ-стойност вериги на допълнителното поле |
| algorithm_fields -> default_key | По подразбиране стойност на допълнителното поле. Една от ключовете на <code>algorithm_fields -> options</code> |
| algorithm_descriptions | Съдържа информация за описанията на типа разделяне |
| algorithm_descriptions -> short_description | Кратко описание на типа разделяне, което не използва HTML. |
| algorithm_descriptions -> long_description | Подробно описание на типа разделяне, което използва HTML. |
| algorithm_descriptions -> lang | Специфициран езиков код на описанието. |
За да получите информация за последните новини за MVSEP, трябва да извършите GET заявка към следния URL:
https://mvsep.com/api/app/news
| Неуспешен опит | Вид | Описание |
|---|---|---|
| lang | String | (по избор) 2-символен езиков код (en, ru) |
| start | Integer | (по избор) Начален офсет, по подразбиране е 0 (т.е. започва от последните новини) |
| limit | Integer | (по избор) Максимален брой резултати, по подразбиране 10, максимален брой 20. |
curl --location --request GET 'https://mvsep.com/api/app/news?lang=en&start=2&limit=1'
Връща данни като масив:
| Ключ | Стойност |
|---|---|
| title | Заглавие на новината. |
| lang | Заглавие на новината. |
| text | Пълно описание на новината |
| created_at | Дата на новината |
To get site queue information, you need to make a GET call to the following url:
https://mvsep.com/api/app/queue
| Неуспешен опит | Вид | Описание |
|---|---|---|
| api_token | String | (optional) API ключ на потребителя |
curl --location --request GET 'https://mvsep.com/api/app/queue'
| Ключ | Стойност |
|---|---|
| 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):
|
За да получите информация за демо разделянията, трябва да направите "GET" повикване на следния URL адрес:
https://mvsep.com/api/app/demo
| Неуспешен опит | Вид | Описание |
|---|---|---|
| start | Integer | (по избор) Начален офсет, по подразбиране е 0 (т.е. започва от последните новини) |
| limit | Integer | (по избор) Максимален брой резултати, по подразбиране 10, максимален брой 20. |
curl --location --request GET 'https://mvsep.com/api/app/demo?start=0&limit=2'
Връща данни като масив:
| Ключ | Стойност |
|---|---|
| hash | Хеш за разделяне |
| date | Дата на раздялата. |
| input_audio | URL адресът на входното аудио |
| size | Размерът на входното аудио. |
| algorithm | Съдържа основна информация за използвания тип разделяне (за информация относно върнатите параметри вижте раздела GET SEPARATION TYPES). |
За да удостоверите потребителя и да получите API ключ на потребителя, трябва да направите "POST" извикване на следния URL адрес:
https://mvsep.com/api/app/login
| Неуспешен опит | Вид | Описание |
|---|---|---|
| String | Имейл адрес на потребителя | |
| password | String | Парола на потребителя |
curl --location --request POST 'https://mvsep.com/api/app/login' --form 'email="<Имейл адрес на потребителя>"' --form 'password="<Парола на потребителя>"'
| Ключ | Стойност |
|---|---|
| success |
|
| data | Съдържа информация, когато пълномощията са валидни |
| data -> name | Име на потребителя |
| data -> email | Имейл адрес на потребителя |
| data -> api_token | API ключ на потребителя. Уверете се, че го съхранявате в сигурно място и го използвате за последващи операции. |
| data -> premium_minutes | Кредити, останали за потребителя |
| data -> premium_enabled |
Дали потребителят разрешава разходването на кредити.
|
| data -> long_filenames_enabled |
Дали потребителят иска допълнителна информация в имената на файловете:
|
MVSEP API използва следният код за наизправност:
| Код за неизправност | Значение |
|---|---|
| 400 | Невалидни данни за удостоверяване |
За да регистрирате потребител в сайта MVSEP, трябва да извършите POST заявка към следния URL:
https://mvsep.com/api/app/register
| Неуспешен опит | Вид | Описание |
|---|---|---|
| name | String | Име на потребителя |
| String | Имейл адрес на потребителя | |
| password | String | Парола на потребителя |
| password_confirmation | String | Повторете паролата на потребителя |
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"'
| Ключ | Стойност |
|---|---|
| success |
|
| message | Настъпва, когато формата е валидна |
MVSEP API използва следният код за наизправност:
| Код за неизправност | Значение |
|---|---|
| 400 | Формата е невалидна |
За да получите информация за потребителя, трябва да извършите GET заявка към следния URL:
https://mvsep.com/api/app/user
| Неуспешен опит | Вид | Описание |
|---|---|---|
| api_token | String | API ключ на потребителя |
curl --location --request GET 'https://mvsep.com/api/app/user?api_token=<Вашият API токен>'
| Ключ | Стойност |
|---|---|
| success |
|
| data | Съдържа информация, когато пълномощията са валидни |
| data -> name | Име на потребителя |
| data -> email | Имейл адрес на потребителя |
| data -> api_token | API ключ на потребителя. Уверете се, че го съхранявате в сигурно място и го използвате за последващи операции. |
| data -> premium_minutes | Кредити, останали за потребителя |
| data -> premium_enabled |
Дали потребителят разрешава разходването на кредити.
|
| data -> long_filenames_enabled |
Дали потребителят иска допълнителна информация в имената на файловете:
|
| data -> current_queue | Показва текущи разделяния за потребителя |
MVSEP API използва следният код за наизправност:
| Код за неизправност | Значение |
|---|---|
| 400 | Невалиден API ключ |
За да получите основна информация за историята на разделяне на потребителя, трябва да извършите GET заявка към следния URL:
https://mvsep.com/api/app/separation_history
| Неуспешен опит | Вид | Описание |
|---|---|---|
| api_token | String | API ключ на потребителя |
| start | Integer | (по избор) Начален офсет, по подразбиране е 0 (т.е. започва от последните новини) |
| limit | Integer | (по избор) Максимален брой резултати, по подразбиране 10, максимален брой 20. |
curl --location --request GET 'https://mvsep.com/api/app/separation_history?api_token=<Вашият API токен>&start=1&limit=2'
| Ключ | Стойност |
|---|---|
| success |
|
| data | Съдържа основна информация в масив за предишни разделяния |
| data -> hash | Хеш за разделяне |
| data -> job_exists | Съдържа основна информация в масив за предишни разделяния |
| data -> credits | Колко кредити са използвани за задачата, null ако разделянето не съществува |
| data -> time_left | Приблизително време до изтриването на задачата |
| data -> algorithm | Съдържа основна информация за използвания тип разделяне (за информация относно върнатите параметри вижте раздела GET SEPARATION TYPES). |
MVSEP API използва следният код за наизправност:
| Код за неизправност | Значение |
|---|---|
| 400 | Невалиден API ключ |
За да активирате премиум използването за потребителя, трябва да извършите POST заявка към следния URL:
https://mvsep.com/api/app/enable_premium
| Неуспешен опит | Вид | Описание |
|---|---|---|
| api_token | String | API ключ на потребителя |
curl --location --request POST 'https://mvsep.com/api/app/enable_premium' --form 'api_token="<Вашият API токен>"'
| Ключ | Стойност |
|---|---|
| success |
|
| message | Информира за статуса на операцията |
MVSEP API използва следният код за наизправност:
| Код за неизправност | Значение |
|---|---|
| 400 | Невалиден API ключ |
За да деактивирате използването на Premium за потребителя, трябва да направите POST повикване към следния url адрес:
https://mvsep.com/api/app/disable_premium
| Неуспешен опит | Вид | Описание |
|---|---|---|
| api_token | String | API ключ на потребителя |
curl --location --request POST 'https://mvsep.com/api/app/disable_premium' --form 'api_token="<Вашият API токен>"'
| Ключ | Стойност |
|---|---|
| success |
|
| message | Информира за статуса на операцията |
MVSEP API използва следният код за наизправност:
| Код за неизправност | Значение |
|---|---|
| 400 | Невалиден API ключ |
За да активирате дългите имена на файлове за потребителя, трябва да направите POST повикване към следния url адрес:
https://mvsep.com/api/app/enable_long_filenames
| Неуспешен опит | Вид | Описание |
|---|---|---|
| api_token | String | API ключ на потребителя |
curl --location --request POST 'https://mvsep.com/api/app/enable_long_filenames' --form 'api_token="<Вашият API токен>"'
| Ключ | Стойност |
|---|---|
| success |
|
| message | Информира за статуса на операцията |
MVSEP API използва следният код за наизправност:
| Код за неизправност | Значение |
|---|---|
| 400 | Невалиден API ключ |
За да забраните дългите имена на файлове за потребителя, трябва да направите POST повикване към следния url адрес:
https://mvsep.com/api/app/disable_long_filenames
| Неуспешен опит | Вид | Описание |
|---|---|---|
| api_token | String | API ключ на потребителя |
curl --location --request POST 'https://mvsep.com/api/app/disable_long_filenames' --form 'api_token="<Вашият API токен>"'
| Ключ | Стойност |
|---|---|
| success |
|
| message | Информира за статуса на операцията |
MVSEP API използва следният код за наизправност:
| Код за неизправност | Значение |
|---|---|
| 400 | Невалиден API ключ |
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
| Неуспешен опит | Вид | Описание |
|---|---|---|
| start | Integer | (по избор) Начален офсет, по подразбиране е 0 (т.е. започва от последните новини) |
| limit | Integer | (по избор) Максимален брой резултати, по подразбиране 10, максимален брой 20. |
curl --location --request GET 'https://mvsep.com/api/quality_checker/queue?&start=1&limit=2'
Връща данни като масив:
| Ключ | Стойност |
|---|---|
| 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
| Неуспешен опит | Вид | Описание |
|---|---|---|
| dataset_type | String | Dataset Type, defaults to 0 if not given
|
| start | Integer | (по избор) Начален офсет, по подразбиране е 0 (т.е. започва от последните новини) |
| limit | Integer | (по избор) Максимален брой резултати, по подразбиране 10, максимален брой 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'
| Ключ | Стойност |
|---|---|
| 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
| Неуспешен опит | Вид | Описание |
|---|---|---|
| api_token | String | (required) Вашият API ключ |
| zipfile | Binary | (required) Zip file to be processed |
| algo_name | String | (required) Name of the algorithm |
| main_text | String | (required) Description of the algorithm |
| dataset_type | String | Dataset type. Defaults to 0.
|
| password | String | (required) Password to delete algorithm |
| ensemble | integer | 0 - algorithm is not ensemble. 1 - algorithm is ensemble. |
curl --location 'https://mvsep.com/api/quality_checker/add' --form 'zipfile=@"/path/to/zipfile"' --form 'algo_name="Test Algorithm Name"' --form 'main_text="Test Algorithm Description"' --form 'dataset_type="2"' --form 'ensemble="1"' --form 'password="test"'
| Ключ | Стойност |
|---|---|
| success |
|
| data | Contains information about entry |
| data -> id | ID of the entry. |
| data -> link | Link to the entry. |
MVSEP API използва следният код за наизправност:
| Код за неизправност | Значение |
|---|---|
| 400 | Формата е невалидна |
| 401 |
Неизвестен или невалиден api_token. Тази грешка се появява ако сте използвали неизвестен API ключ
|
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
| Неуспешен опит | Вид | Описание |
|---|---|---|
| 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
| Неуспешен опит | Вид | Описание |
|---|---|---|
| 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"'
| Ключ | Стойност |
|---|---|
| success |
|
| data->message | Shows whether entry was deleted |
turbo@mvsep.com
Често задавани въпроси
Проверка на качеството
Алгоритми
Пълна документация на API