API MVSEP предоставляет программный доступ для создания разделения, возврата результатов, получения информации о сайте и управления возможностями пользователя.
Чтобы использовать этот API, вам нужен ключ API. Вы не вошли, пожалуйста, войдите для получения токена API.
Примеры в Питоне: https://github.com/ZFTurbo/MVSep-API-Examples
Неофициальное приложение MacVSep для Mac OS: https://github.com/septcoco/macvsep
Webhooks can be set up here: Webhooks Page
Спецификация OpenAPI: mvsep-openapi-spec.json
Note that Premium users can request unlimited concurrent jobs, while non-Premium users can only request 1 concurrent job.
Чтобы создать разделение, вам нужно сделать POST-вызов по следующему URL-адресу:
https://mvsep.com/api/separation/create
| Поле | Тип | Описание |
|---|---|---|
| api_token | String | Ваш ключ API |
| audiofile | Binary | Audiofile to be processed. Not required if url parameter is set or the model does 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 | (необязательно) Тип разделения, по умолчанию 11 (Demucs3 Model B (вокал, ударные, бас, другое)) |
| add_opt1 | String | (необязательно) Тип разделения первое дополнительное поле |
| add_opt2 | String | (необязательно) Тип разделения второе дополнительное поле |
| add_opt3 | String | (необязательно) Третье дополнительное поле типа разделения |
| output_format | Integer | (необязательно) выходной формат, по умолчанию 0 (mp3 (320kbps)) |
| is_demo | Boolean | (необязательно) если разделение будет опубликовано на демонстрационной странице, по умолчанию false |
| Наименование | Значение | Additional fields |
|---|---|---|
| Ensemble (vocals, instrum) | 26 | Поле: add_opt1 Наименование: Output files Опции:
Поле: add_opt2 Наименование: Model Type Опции:
|
| Ensemble (vocals, instrum, bass, drums, other) | 28 | Поле: add_opt1 Наименование: Output files Опции:
Поле: add_opt2 Наименование: Model Type Опции:
|
| Ensemble All-In (vocals, bass, drums, piano, guitar, lead/back vocals, other) | 30 | Поле: add_opt1 Наименование: Output files Опции:
Поле: add_opt2 Наименование: Model Type Опции:
|
| BS Roformer SW (vocals, bass, drums, guitar, piano, other) | 63 | |
| Demucs4 HT (vocals, drums, bass, other) | 20 | Поле: add_opt1 Наименование: Model type Опции:
|
| BS Roformer (vocals, instrumental) | 40 | Поле: add_opt1 Наименование: Vocal model type Опции:
|
| BS PolarFormer (vocals, instrumental) | 123 | Поле: add_opt1 Наименование: Overlap Опции:
|
| MelBand Roformer (vocals, instrumental) | 48 | Поле: add_opt1 Наименование: Vocal model type Опции:
|
| MDX23C (vocals, instrumental) | 25 | Поле: add_opt1 Наименование: Vocal model type Опции:
|
| SCNet (vocals, instrumental) | 46 | Поле: add_opt1 Наименование: Vocal model type Опции:
|
| MDX B (vocals, instrumental) | 23 | Поле: add_opt1 Наименование: Vocal model type Опции:
|
| Ultimate Vocal Remover VR (vocals, music) | 9 | Поле: add_opt1 Наименование: Model Type Опции:
Поле: add_opt2 Наименование: Agressiveness Опции:
|
| Demucs4 Vocals 2023 (vocals, instrum) | 27 | |
| MVSep Karaoke (lead/back vocals) | 49 | Поле: add_opt1 Наименование: Karaoke model type Опции:
Поле: add_opt2 Наименование: Extraction type Опции:
|
| MDX-B Karaoke (lead/back vocals) | 12 | Поле: add_opt1 Наименование: Karaoke model type Опции:
|
| MVSep Crowd removal (crowd, other) | 34 | Поле: add_opt1 Наименование: Model type Опции:
|
| Medley Vox (Multi-singer separation) | 53 | Поле: add_opt1 Наименование: Model type Опции:
|
| MVSep Multichannel BS (vocals, instrumental) | 43 | Поле: add_opt1 Наименование: Model Type Опции:
|
| MVSep Male/Female separation | 57 | Поле: add_opt1 Наименование: Model type Опции:
Поле: add_opt2 Наименование: How to extract Опции:
|
| MVSep Choir (choir, other) | 112 | Поле: add_opt2 Наименование: How to extract Опции:
|
| MVSep SATB Choir (soprano, alto, tenor, bass) | 111 | Поле: add_opt1 Наименование: Model type Опции:
Поле: add_opt2 Наименование: How to extract Опции:
|
| MVSep Drums (drums, other) | 44 | Поле: add_opt1 Наименование: Drums model type Опции:
Поле: add_opt2 Наименование: How to extract Опции:
Поле: add_opt3 Наименование: Output files Опции:
|
| MVSep Bass (bass, other) | 41 | Поле: add_opt1 Наименование: Bass model type Опции:
Поле: add_opt2 Наименование: How to extract Опции:
Поле: add_opt3 Наименование: Output files Опции:
|
| MVSep Synth (synth, other) | 88 | Поле: add_opt1 Наименование: How to extract Опции:
|
| DrumSep (4-6 stems: kick, snare, cymbals, toms, ride, hh, crash) | 37 | Поле: add_opt1 Наименование: Model Type Опции:
Поле: add_opt2 Наименование: Preprocess Опции:
|
| MVSep Piano (piano, other) | 29 | Поле: add_opt1 Наименование: Piano model type Опции:
|
| MVSep Digital Piano (digital-piano, other) | 79 | Поле: add_opt2 Наименование: How to extract Опции:
|
| MVSep Keys (keys, other) | 106 | |
| MVSep Organ (organ, other) | 58 | Поле: add_opt1 Наименование: Organ model type Опции:
|
| MVSep Harpsichord (harpsichord, other) | 91 | |
| MVSep Accordion (accordion, other) | 99 | |
| MVSep Guitar (guitar, other) | 31 | Поле: add_opt1 Наименование: Guitar model type Опции:
|
| MVSep Acoustic Guitar (acoustic-guitar, other) | 66 | Поле: add_opt2 Наименование: How to extract Опции:
|
| MVSep Electric Guitar (electric-guitar, other) | 81 | Поле: add_opt2 Наименование: How to extract Опции:
|
| MVSep Lead/Rhythm Guitar (lead-guitar, rhythm-guitar) | 101 | Поле: add_opt1 Наименование: Model type Опции:
|
| 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 | Поле: add_opt1 Наименование: String model type Опции:
Поле: add_opt2 Наименование: How to extract Опции:
|
| MVSep Violin (violin, other) | 65 | |
| MVSep Viola (viola, other) | 69 | Поле: add_opt2 Наименование: How to extract Опции:
|
| MVSep Cello (cello, other) | 70 | Поле: add_opt2 Наименование: How to extract Опции:
|
| MVSep Double Bass (double-bass, other) | 73 | Поле: add_opt2 Наименование: How to extract Опции:
|
| MVSep Wind (wind, other) | 54 | Поле: add_opt1 Наименование: Wind model type Опции:
Поле: add_opt2 Наименование: How to extract Опции:
Поле: add_opt3 Наименование: Output files Опции:
|
| MVSep Brass (brass, other) | 107 | Поле: add_opt1 Наименование: How to extract Опции:
|
| MVSep Woodwind (woodwind, other) | 108 | Поле: add_opt1 Наименование: How to extract Опции:
|
| MVSep Saxophone (saxophone, other) | 61 | Поле: add_opt1 Наименование: Model type Опции:
|
| MVSep Flute (flute, other) | 67 | Поле: add_opt1 Наименование: Flute model type Опции:
Поле: add_opt2 Наименование: How to extract Опции:
|
| MVSep Trumpet (trumpet, other) | 71 | Поле: add_opt2 Наименование: How to extract Опции:
|
| MVSep Trombone (trombone, other) | 75 | Поле: add_opt2 Наименование: How to extract Опции:
|
| MVSep Oboe (oboe, other) | 77 | Поле: add_opt2 Наименование: How to extract Опции:
|
| MVSep Clarinet (clarinet, other) | 78 | Поле: add_opt2 Наименование: How to extract Опции:
|
| MVSep French Horn (french-horn, other) | 82 | Поле: add_opt2 Наименование: How to extract Опции:
|
| MVSep Harmonica (harmonica, other) | 87 | Поле: add_opt2 Наименование: How to extract Опции:
|
| MVSep Tuba (tuba, other) | 92 | |
| MVSep Bassoon (bassoon, other) | 93 | |
| MVSep Bagpipes (bagpipes , other) | 116 | Поле: add_opt2 Наименование: How to extract Опции:
|
| 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 | Поле: add_opt2 Наименование: How to extract Опции:
|
| MVSep Celesta (celesta, other) | 110 | Поле: add_opt2 Наименование: How to extract Опции:
|
| MVSep Demucs4HT DNR (speech, music, effects) | 24 | Поле: add_opt1 Наименование: Model type Опции:
|
| BandIt Plus (speech, music, effects) | 36 | |
| BandIt v2 (speech, music, effects) | 45 | Поле: add_opt1 Наименование: Model Type Опции:
|
| MVSep DnR v3 (speech, music, effects) | 56 | Поле: add_opt1 Наименование: Model type Опции:
Поле: add_opt2 Наименование: How to extract Опции:
Поле: add_opt3 Наименование: Output files Опции:
|
| MVSep Braam | 117 | |
| MVSep Risers | 125 | |
| MVSep FX | 122 | |
| Apollo Enhancers (by JusperLee, Lew, baicai1145) | 51 | Поле: add_opt1 Наименование: Model type Опции:
Поле: add_opt2 Наименование: Cutoff (Hz) Опции:
|
| Reverb Removal (noreverb) | 22 | Поле: add_opt1 Наименование: Model Type Опции:
Поле: add_opt2 Наименование: Preprocess Опции:
|
| DeNoise by aufr33 and gabox | 47 | Поле: add_opt1 Наименование: Model type Опции:
|
| AudioSR (Super Resolution) | 59 | Поле: add_opt1 Наименование: Cutoff (Hz) Опции:
|
| FlashSR (Super Resolution) | 60 | |
| Stable Audio Open Gen | 62 | Поле: add_opt1 Наименование: Text prompt Опции: Поле: add_opt2 Наименование: Length (in seconds) Опции:
|
| Whisper (extract text from audio) | 39 | Поле: add_opt1 Наименование: Model type Опции:
Поле: add_opt2 Наименование: Transcription type Опции:
|
| Parakeet (extract text from audio) | 64 | Поле: add_opt1 Наименование: Model type Опции:
Поле: add_opt2 Наименование: Version Опции:
|
| VibeVoice (Voice Cloning) | 103 | Поле: add_opt1 Наименование: Model type Опции:
Поле: add_opt2 Наименование: Text prompt Опции: Поле: add_opt3 Наименование: Extract vocals first Опции:
|
| VibeVoice (TTS) | 104 | Поле: add_opt1 Наименование: Model type Опции:
Поле: add_opt2 Наименование: Text prompt Опции: |
| Qwen3-TTS (Custom Voice) | 118 | Поле: add_opt1 Наименование: Text prompt Опции: Поле: add_opt2 Наименование: Speaker Опции:
Поле: add_opt3 Наименование: Language Опции:
Поле: add_opt4 Наименование: Voice description Опции: |
| Qwen3-TTS (Voice Design) | 119 | Поле: add_opt1 Наименование: Text prompt Опции: Поле: add_opt2 Наименование: Voice description Опции: Поле: add_opt3 Наименование: Language Опции:
|
| Qwen3-TTS (Voice Cloning) | 120 | Поле: add_opt1 Наименование: Text prompt Опции: Поле: add_opt2 Наименование: Reference text in audio (optional) Опции: Поле: add_opt3 Наименование: Language Опции:
Поле: add_opt4 Наименование: Extract vocals first Опции:
|
| Mega 53-stem Model | 126 | |
| Bark (Speech Gen) | 115 | Поле: add_opt1 Наименование: Text prompt Опции: Поле: add_opt2 Наименование: Speaker Опции:
|
| MVSep MultiSpeaker (MDX23C) | 42 | Поле: add_opt1 Наименование: Model Type Опции:
|
| Aspiration (by Sucial) | 50 | Поле: add_opt1 Наименование: Model type Опции:
|
| Phantom Centre extraction | 55 | Поле: add_opt1 Наименование: Model type Опции:
|
| Matchering (by sergree) | 68 | |
| SOME (Singing-Oriented MIDI Extractor) | 80 | Поле: add_opt1 Наименование: How to use Опции:
|
| Transkun (piano -> midi) | 113 | Поле: add_opt1 Наименование: How to extract Опции:
|
| Basic Pitch (MIDI Extraction) | 114 | |
| HeartMuLa (Song Gen) | 121 | Поле: add_opt1 Наименование: Lyrics Опции: Поле: add_opt10 Наименование: Topic Опции:
Поле: add_opt2 Наименование: Tags (optional) Опции: Поле: add_opt3 Наименование: Genre Опции:
Поле: add_opt4 Наименование: Timbre Опции:
Поле: add_opt5 Наименование: Gender Опции:
Поле: add_opt6 Наименование: Mood Опции:
Поле: add_opt7 Наименование: Instrument Опции:
Поле: add_opt8 Наименование: Scene Опции:
Поле: add_opt9 Наименование: Region Опции:
|
| Demucs3 Model (vocals, drums, bass, other) | 10 | Поле: add_opt1 Наименование: Model type Опции:
|
| MDX A/B (vocals, drums, bass, other) | 7 | Поле: add_opt1 Наименование: Vocal model type Опции:
|
| Vit Large 23 (vocals, instrum) | 33 | Поле: add_opt1 Наименование: Model type Опции:
|
| UVRv5 Demucs (vocals, music) | 17 | Поле: add_opt1 Наименование: Model Type Опции:
|
| 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 | Поле: add_opt1 Наименование: Model type Опции:
|
| UnMix | 3 | Поле: add_opt1 Наименование: Model type Опции:
|
| Zero Shot (Query Based) (Low quality) | 14 | Поле: add_opt1 Наименование: Model Type Опции:
|
| LarsNet (kick, snare, cymbals, toms, hihat) | 38 | Поле: add_opt1 Наименование: Model type Опции:
|
| Наименование | Значение |
|---|---|
| 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 "ПОЛУЧИТЬ РЕЗУЛЬТАТ" созданной задачи (показывается только когда success равно true) |
| data -> hash | Показывает хэш созданной задачи (показывается только когда success равно true) |
| data -> message | Показывает описание ошибки (показывается только когда success равно false) |
API MVSEP использует следующие коды ошибок:
| Код ошибки | Значение |
|---|---|
| 400 | Некоторые параметры отсутствуют или недействительны. Эта ошибка появляется, когда вы не передаете все обязательные параметры или передаете недопустимые параметры. |
| 401 |
Неизвестный или недопустимый api_token. Эта ошибка появляется, если вы используете неизвестный ключ API
|
Чтобы получить результат разделения, вам нужно сделать вызов GET по следующему URL-адресу:
https://mvsep.com/api/separation/get
| Поле | Тип | Описание |
|---|---|---|
| hash | String | Хэш разделения |
| mirror | Integer | (необязательно) Используется другое зеркало, если установлено значение 1, по умолчанию 0. Требуется api_token и 1 кредит, если установлено значение 1. |
| api_token | String | (необязательно) API-ключ пользователя. Требуется, если параметр зеркала установлен на 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 a 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 status description (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 forms 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. |
| algorithm_id | Integer | Optional separation type ID. Use this to return demo separations created by one algorithm only. Values match render_id from the GET SEPARATION TYPES endpoint. |
| options[FIELD] | String / Integer | Optional filter for algorithm option values. Replace FIELD with an additional field key from algorithm_fields -> name in the GET SEPARATION TYPES response, then pass one of that field's options keys as the value. Example: options[vocals]=1. |
| additional_options | String | Optional raw contains filter against stored job option data. Prefer options[FIELD] for new integrations because it is explicit and easier to compose. |
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'
To build option filters, first call https://mvsep.com/api/app/algorithms and inspect each algorithm's algorithm_fields list. Use the field name inside options[FIELD] and use one of the JSON option keys as the value.
Возвращает данные в виде массива:
| Поле | Значение |
|---|---|
| hash | Хэш разделения |
| date | Дата разделения |
| input_audio | Введите URL-адрес аудио |
| size | Введите размер аудио |
| algorithm | Содержит основную информацию об используемом типе разделения (информацию о возвращаемых параметрах см. на вкладке GET SEPARATION TYPES). |
Чтобы аутентифицировать пользователя и получить его API-ключ, необходимо выполнить POST-вызов по следующему url:
https://mvsep.com/api/app/login
| Поле | Тип | Описание |
|---|---|---|
| String | E-mail пользователя | |
| password | String | Пароль пользователя |
curl --location --request POST 'https://mvsep.com/api/app/login' --form 'email="<E-mail пользователя>"' --form 'password="<Пароль пользователя>"'
| Поле | Значение |
|---|---|
| success |
|
| data | Содержит информацию о том, когда учётные данные действительны. |
| data -> name | Имя пользователя |
| data -> email | E-mail пользователя |
| data -> api_token | API-ключ пользователя. Обязательно сохраните его в надёжном хранилище и используйте для последующих операций. |
| data -> premium_minutes | Оставшийся кредиты для пользователя |
| data -> premium_enabled |
Разрешено ли пользователю расходовать кредиты.
|
| data -> long_filenames_enabled |
Хочет ли пользователь получить дополнительную информацию в именах файлов:
|
API MVSEP использует следующие коды ошибок:
| Код ошибки | Значение |
|---|---|
| 400 | Указаны неверные учетные данные |
Чтобы зарегистрировать пользователя на сайте MVSEP, необходимо выполнить POST-вызов по следующему адресу:
https://mvsep.com/api/app/register
| Поле | Тип | Описание |
|---|---|---|
| name | String | Имя пользователя |
| String | E-mail пользователя | |
| 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 | Происходит, когда форма действительна |
API MVSEP использует следующие коды ошибок:
| Код ошибки | Значение |
|---|---|
| 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 | E-mail пользователя |
| data -> api_token | API-ключ пользователя. Обязательно сохраните его в надёжном хранилище и используйте для последующих операций. |
| data -> premium_minutes | Оставшийся кредиты для пользователя |
| data -> premium_enabled |
Разрешено ли пользователю расходовать кредиты.
|
| data -> long_filenames_enabled |
Хочет ли пользователь получить дополнительную информацию в именах файлов:
|
| data -> current_queue | Показывает текущие разделения для пользователя |
API MVSEP использует следующие коды ошибок:
| Код ошибки | Значение |
|---|---|
| 400 | Неверный ключ API |
Для получения основной информации история разделения пользователя, вам необходимо сделать POST-вызов по следующему 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 | Сколько кредитов было использовано для выполнения задания, нулевое значение, если разделения не существует |
| data -> time_left | Примерное время, оставшееся до удаления задания |
| data -> algorithm | Содержит основную информацию об используемом типе разделения (информацию о возвращаемых параметрах см. на вкладке GET SEPARATION TYPES). |
API MVSEP использует следующие коды ошибок:
| Код ошибки | Значение |
|---|---|
| 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 | Информирует о состоянии операции |
API MVSEP использует следующие коды ошибок:
| Код ошибки | Значение |
|---|---|
| 400 | Неверный ключ API |
Чтобы отключить использование премиума для пользователя, вам необходимо сделать 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 | Информирует о состоянии операции |
API MVSEP использует следующие коды ошибок:
| Код ошибки | Значение |
|---|---|
| 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 | Информирует о состоянии операции |
API MVSEP использует следующие коды ошибок:
| Код ошибки | Значение |
|---|---|
| 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 | Информирует о состоянии операции |
API MVSEP использует следующие коды ошибок:
| Код ошибки | Значение |
|---|---|
| 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 | Имя выбранного типа/алгоритма разделения |
| main_text | Описание выбранного типа/алгоритма разделения |
| proc | Статус обработки
|
| 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 | (обязательно) Ваш ключ API |
| zipfile | Binary | (обязательно) Zip файл обрабатывается |
| algo_name | String | (обязательно) Название алгоритма |
| main_text | String | (обязательно) Описание алгоритма |
| dataset_type | String | Dataset type. Defaults to 0.
|
| password | String | (обязательно) Пароль для удаления алгоритма |
| 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 | Ссылка на запись |
API MVSEP использует следующие коды ошибок:
| Код ошибки | Значение |
|---|---|
| 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 | (обязательно) 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 | (обязательно) ID of the entry |
| password | String | (обязательно) 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 |