turbo@mvsep.com
API MVSEP предоставляет программный доступ для создания разделения, возврата результатов, получения информации о сайте и управления возможностями пользователя.
Чтобы использовать этот 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
Обратите внимание, что пользователи Premium могут запрашивать до 10 одновременных заданий, а пользователи без Premium могут запрашивать только 1 одновременное задание.
Чтобы создать разделение, вам нужно сделать POST-вызов по следующему URL-адресу:
https://mvsep.com/api/separation/create
| Поле | Тип | Описание |
|---|---|---|
| api_token | String | Ваш ключ API |
| audiofile | Binary | Аудиофайл для обработки. 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 | (необязательно) Тип разделения, по умолчанию 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 | 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 | |
| MelBand 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 Guitar (guitar, other) | 31 | Key: add_opt1 Name: Guitar model type 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 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 Strings (strings, other) | 52 | |
| 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 Violin (violin, other) | 65 | |
| Apollo Enhancers (by JusperLee and Lew) | 51 | Key: add_opt1 Name: Model type 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 (dialog, sfx, music) | 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, sfx) | 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:
|
| MDX A/B (vocals, drums, bass, other) | 7 | Key: add_opt1 Name: Vocal model type Options:
|
| Demucs3 Model (vocals, drums, bass, other) | 10 | Key: add_opt1 Name: 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 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 |
| Наименование | Значение |
|---|---|
| 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 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
curl --location --request GET 'https://mvsep.com/api/app/algorithms'
Возвращает данные в виде массива:
| Поле | Значение |
|---|---|
| render_id | Значение типа разделения (ID) |
| name | Имя типа разделения |
| algorithm_group_id |
Группа, к которой принадлежит тип разделения:
|
| 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 | 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 | 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. |
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 | (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