turbo@mvsep.com
Interfejs API MVSEP umożliwia programowo utworzenie zadania separacji, uzyskanie dostępu do wyników oraz informacji o witrynie, a także sprawdzanie możliwości konta użytkownika.
Aby używać tego API, potrzebujesz klucza API. Nie jesteś zalogowany. Zaloguj się, aby móc uzyskać swój token 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
Pamiętaj, że użytkownicy Premium mogą rozpocząć maksymalnie 10 zadań na raz, podczas gdy użytkownicy bez Premium mogą rozpocząć tylko 1 zadanie na raz.
Aby wykonać separację, należy dokonać wywołania POST do następującego adresu:
https://mvsep.com/api/separation/create
| Pole | Typ | Opis |
|---|---|---|
| api_token | String | Twój klucz API |
| audiofile | Binary | Plik audio, który ma zostać przetworzony. 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 | (opcjonalne) Rodzaj Separacji, domyślnie 11 (Demucs3 Model B (vocals, drums, bass, other)) |
| add_opt1 | String | (opcjonalne) Typ Separacji pierwsze dodatkowe pole |
| add_opt2 | String | (opcjonalne) Typ Separacji drugie dodatkowe pole |
| add_opt3 | String | Typ separacji - trzecie dodatkowe pole |
| output_format | Integer | (opcjonalne) format wyjściowy, domyślnie 0 (mp3 (320kbps)) |
| is_demo | Boolean | (opcjonalne) czy separacja powinna zostać upubliczniona na stronie demonstracyjnej, domyślnie wyłączone |
| Nazwa | Wartość | 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 |
| Nazwa | Wartość |
|---|---|
| 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="<Twój token API>"'
--form 'sep_type="9"'
--form 'add_opt1="0"'
--form 'add_opt2="1"'
--form 'output_format="1"'
--form 'is_demo="1"'
| Klucz | Wartość |
|---|---|
| success |
|
| data | Przechowuje dodatkowe informacje w zależności od pola success |
| data -> link | Wyświetla hiperłącze "POKAŻ WYNIK" dla utworzonego zadania (jeśli pole success ma wartość true) |
| data -> hash | Wyświetla skrót dla utworzonego zadania (jeśli pole success ma wartość true) |
| data -> message | Wyświetla opis błędu (jeśli pole success ma wartość false) |
API MVSEP stosuje następujące kody błędów:
| Kod Błędu | Znaczenie |
|---|---|
| 400 | Brak niektórych parametrów lub są one niepoprawne. Ten błąd występuje, kiedy nie podasz wszystkich obowiązkowych parametrów albo podasz niepoprawne parametry. |
| 401 |
Nieznany lub niepoprawny api_token. Ten błąd występuje, jeśli używasz nieznanego klucza API
|
Aby uzyskać wynik separacji, należy dokonać wywołania GET do następującego adresu:
https://mvsep.com/api/separation/get
| Pole | Typ | Opis |
|---|---|---|
| hash | String | Suma kontrolna separacji |
| mirror | Integer | (opcjonalnie) Powoduje wykorzystanie innego serwera lustrzanego gdy ustawione na 1, domyślnie - 0. Wymaga podania api_token oraz posiadania co najmniej jednego kredytu. |
| api_token | string | (opcjonalnie) Klucz API użytkownika. Wymagany jeśli parametr mirror ma wartość 1. |
curl --location --request GET 'https://mvsep.com/api/separation/get?hash=20230327071601-0e3e5c6c85-13-dimensions.mp3'
| Klucz | Wartość |
|---|---|
| success |
|
| status |
|
| data | Przechowuje dodatkowe informacje w zależności od pola success |
| data -> queue_count | Wyświetla liczbę nieobsłużonych jeszcze zadań o identycznym priorytecie (jedynie gdy pole status ma wartość waiting lub distributing) |
| data -> current_order | Wyświetla numer miejsca w kolejce dla zadania użytkownika (jedynie gdy pole status ma wartość waiting lub distributing) |
| data -> message | Wyświetla opis stanu (dotyczy wszystkich statusów ale jeżeli pole status ma wartość failed - zawiera wtedy powód błędu). |
| data -> algorithm | Wyświetla nazwę użytego algorytmu separacji dla zadania (jedynie gdy pole status ma wartość done) |
| data -> algorithm_description | Wyświetla szczegóły użytego algorytmu separacji dla zadania (jedynie gdy pole status ma wartość done) |
| data -> output_format | Wyświetla format wyjściowy zadania (jedynie gdy pole status ma wartość done) |
| data -> tags | Wyświetla znaczniki metadanych pliku dźwiękowego (jedynie gdy pole status ma wartość done) |
| data -> input_file | Wyświetla szczegóły pobrania źródłowego pliku dźwiękowego (jedynie gdy pole status ma wartość done) |
| data -> files | Wyświetla szczegóły pobrania wynikowych plików dźwiękowych (jedynie gdy pole status ma wartość done) |
| data -> date | Wyświetla datę obsłużenia zadania (jedynie gdy pole status ma wartość done) |
| data -> finished_chunks | Wyświetla liczbę ukończonych fragmentów dla dużego zadania (jedynie gdy pole status ma wartość distributing) |
| data -> all_chunks | Wyświetla liczbę wszystkich fragmentów dla dużego zadania (jedynie gdy pole status ma wartość 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
| Pole | Typ | Opis |
|---|---|---|
| hash | String | Suma kontrolna separacji |
curl --location --request GET 'https://mvsep.com/api/separation/get-remote?hash=n2AwBjy4KsFZfqqR'
| Klucz | Wartość |
|---|---|
| success |
|
| status |
|
| data | Przechowuje dodatkowe informacje w zależności od pola success |
| 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
| Pole | Typ | Opis |
|---|---|---|
| api_token | string | Klucz API użytkownika |
| hash | string | Suma kontrolna separacji |
curl --location --request POST 'https://mvsep.com/api/separation/cancel' --form 'api_token="<Twój token API>"' --form 'hash="<hash>"'
| Klucz | Wartość |
|---|---|
| success |
|
Wywołaj następujący adres URL metodą GET aby uzyskać szczegółowy opis typów separacji:
https://mvsep.com/api/app/algorithms
curl --location --request GET 'https://mvsep.com/api/app/algorithms'
Zwraca dane w postaci tablicy:
| Klucz | Wartość |
|---|---|
| render_id | Wartość typu separacji (ID) |
| name | Nazwa typu separacji |
| algorithm_group_id |
Grupa, do której należy typ separacji
|
| orientation |
Kto może użyć danego typu separacji:
|
| order_id | Kolejność typu separacji na liście |
| price_coefficient |
Wykorzystywany dla określenia kosztu zadania dla użytkownika premium, odejmowanego od posiadanych kredytów. Obliczane przy użyciu następującego wzoru : floor(<czas trwania pliku dźwiękowego w sekundach> * price_coefficient / 60)?:1
|
| usage | Shows monthly usage count of separation type |
| rating | Shows monthly usage rating of separation type as array:
|
| algorithm_fields | Zawiera informacje o dodatkowych polach typu separacji |
| algorithm_fields -> name |
Pokazuje, który dodatkowy pole typu separacji:
|
| algorithm_fields -> text | Nazwa wyświetlana dodatkowego pola typu separacji |
| algorithm_fields -> options | Łańcuchy klucz-wartość zakodowane w JSON dla dodatkowego pola |
| algorithm_fields -> default_key | Domyślna wartość dodatkowego pola. Jedna z kluczy <code>algorithm_fields -> options</code> |
| algorithm_descriptions | Zawiera informacje o opisach typu separacji |
| algorithm_descriptions -> short_description | Krótki opis typu separacji, który nie używa HTML |
| algorithm_descriptions -> long_description | Szczegółowy opis typu separacji, który używa HTML |
| algorithm_descriptions -> lang | Określony kod językowy opisu |
Aby uzyskać informacje o najnowszych wiadomościach dotyczących MVSEP, musisz wykonać zapytanie GET do następującego adresu URL:
https://mvsep.com/api/app/news
| Pole | Typ | Opis |
|---|---|---|
| lang | String | (opcjonalnie) 2-literowy kod języka (en, ru) |
| start | Integer | (opcjonalnie) Punkt początkowy, domyślnie 0 (tzn. zaczyna od najnowszych) |
| limit | Integer | (opcjonalnie) Maksymalna liczba zwracanych wyników, domyślnie 10, maksymalnie 20 |
curl --location --request GET 'https://mvsep.com/api/app/news?lang=en&start=2&limit=1'
Zwraca dane w postaci tablicy:
| Klucz | Wartość |
|---|---|
| title | Tytuł wiadomości |
| lang | Tytuł wiadomości |
| text | Pełny opis wiadomości |
| created_at | Data wiadomości |
To get site queue information, you need to make a GET call to the following url:
https://mvsep.com/api/app/queue
| Pole | Typ | Opis |
|---|---|---|
| api_token | String | (optional) Klucz API użytkownika |
curl --location --request GET 'https://mvsep.com/api/app/queue'
| Klucz | Wartość |
|---|---|
| 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):
|
Aby uzyskać informacje o separacjach demo, musisz wykonać zapytanie GET do następującego adresu URL:
https://mvsep.com/api/app/demo
| Pole | Typ | Opis |
|---|---|---|
| start | Integer | (opcjonalnie) Punkt początkowy, domyślnie 0 (tzn. zaczyna od najnowszych) |
| limit | Integer | (opcjonalnie) Maksymalna liczba zwracanych wyników, domyślnie 10, maksymalnie 20 |
curl --location --request GET 'https://mvsep.com/api/app/demo?start=0&limit=2'
Zwraca dane w postaci tablicy:
| Klucz | Wartość |
|---|---|
| hash | Suma kontrolna separacji |
| date | Data separacji |
| input_audio | URL audio wejściowego |
| size | Rozmiar audio wejściowego |
| algorithm | Zawiera podstawowe informacje o używanym typie separacji (odniesienie do zakładki GET SEPARATION TYPES w celu uzyskania informacji o zwracanych parametrach) |
Aby uwierzytelnić użytkownika i uzyskać klucz API użytkownika, musisz wykonać zapytanie POST do następującego adresu URL:
https://mvsep.com/api/app/login
| Pole | Typ | Opis |
|---|---|---|
| String | Email użytkownika | |
| password | String | Hasło użytkownika |
curl --location --request POST 'https://mvsep.com/api/app/login' --form 'email="<Email użytkownika>"' --form 'password="<Hasło użytkownika>"'
| Klucz | Wartość |
|---|---|
| success |
|
| data | Zawiera informacje, gdy dane uwierzytelniające są prawidłowe |
| data -> name | Nazwa użytkownika |
| data -> email | Email użytkownika |
| data -> api_token | Klucz API użytkownika. Upewnij się, że jest przechowywany w bezpiecznym miejscu i używany do następnych operacji |
| data -> premium_minutes | Pozostałe kredyty dla użytkownika |
| data -> premium_enabled |
Czy użytkownik pozwala na wydawanie kredytów.
|
| data -> long_filenames_enabled |
Czy użytkownik chce dodatkowych informacji w nazwach plików:
|
API MVSEP stosuje następujące kody błędów:
| Kod Błędu | Znaczenie |
|---|---|
| 400 | Podano nieprawidłowe dane uwierzytelniające |
Aby zarejestrować użytkownika na stronie MVSEP, musisz wykonać zapytanie POST do następującego adresu URL:
https://mvsep.com/api/app/register
| Pole | Typ | Opis |
|---|---|---|
| name | String | Nazwa użytkownika |
| String | Email użytkownika | |
| password | String | Hasło użytkownika |
| password_confirmation | String | Powtórz hasło użytkownika |
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"'
| Klucz | Wartość |
|---|---|
| success |
|
| message | Występuje, gdy formularz jest prawidłowy |
API MVSEP stosuje następujące kody błędów:
| Kod Błędu | Znaczenie |
|---|---|
| 400 | Formularz jest nieprawidłowy |
Aby uzyskać informacje o użytkowniku, musisz wykonać zapytanie GET do następującego adresu URL:
https://mvsep.com/api/app/user
| Pole | Typ | Opis |
|---|---|---|
| api_token | String | Klucz API użytkownika |
curl --location --request GET 'https://mvsep.com/api/app/user?api_token=<Twój token API>'
| Klucz | Wartość |
|---|---|
| success |
|
| data | Zawiera informacje, gdy dane uwierzytelniające są prawidłowe |
| data -> name | Nazwa użytkownika |
| data -> email | Email użytkownika |
| data -> api_token | Klucz API użytkownika. Upewnij się, że jest przechowywany w bezpiecznym miejscu i używany do następnych operacji |
| data -> premium_minutes | Pozostałe kredyty dla użytkownika |
| data -> premium_enabled |
Czy użytkownik pozwala na wydawanie kredytów.
|
| data -> long_filenames_enabled |
Czy użytkownik chce dodatkowych informacji w nazwach plików:
|
| data -> current_queue | Pokazuje trwające separacje dla użytkownika |
API MVSEP stosuje następujące kody błędów:
| Kod Błędu | Znaczenie |
|---|---|
| 400 | Nieprawidłowy klucz API |
Aby uzyskać podstawowe informacje o historii separacji użytkownika, musisz wykonać zapytanie GET do następującego adresu URL:
https://mvsep.com/api/app/separation_history
| Pole | Typ | Opis |
|---|---|---|
| api_token | String | Klucz API użytkownika |
| start | Integer | (opcjonalnie) Punkt początkowy, domyślnie 0 (tzn. zaczyna od najnowszych) |
| limit | Integer | (opcjonalnie) Maksymalna liczba zwracanych wyników, domyślnie 10, maksymalnie 20 |
curl --location --request GET 'https://mvsep.com/api/app/separation_history?api_token=<Twój token API>&start=1&limit=2'
| Klucz | Wartość |
|---|---|
| success |
|
| data | Zawiera tablicę podstawowych informacji o wcześniejszych separacjach |
| data -> hash | Suma kontrolna separacji |
| data -> job_exists | Zawiera tablicę podstawowych informacji o wcześniejszych separacjach |
| data -> credits | Ile kredytów zostało użytych do pracy, null, jeśli separacja nie istnieje |
| data -> time_left | Przybliżony czas pozostały do usunięcia pracy |
| data -> algorithm | Zawiera podstawowe informacje o używanym typie separacji (odniesienie do zakładki GET SEPARATION TYPES w celu uzyskania informacji o zwracanych parametrach) |
API MVSEP stosuje następujące kody błędów:
| Kod Błędu | Znaczenie |
|---|---|
| 400 | Nieprawidłowy klucz API |
Aby włączyć użycie premium dla użytkownika, musisz wykonać zapytanie POST do następującego adresu URL:
https://mvsep.com/api/app/enable_premium
| Pole | Typ | Opis |
|---|---|---|
| api_token | String | Klucz API użytkownika |
curl --location --request POST 'https://mvsep.com/api/app/enable_premium' --form 'api_token="<Twój token API>"'
| Klucz | Wartość |
|---|---|
| success |
|
| message | Informuje o statusie operacji |
API MVSEP stosuje następujące kody błędów:
| Kod Błędu | Znaczenie |
|---|---|
| 400 | Nieprawidłowy klucz API |
Aby wyłączyć użycie premium dla użytkownika, musisz wykonać zapytanie POST do następującego adresu URL:
https://mvsep.com/api/app/disable_premium
| Pole | Typ | Opis |
|---|---|---|
| api_token | String | Klucz API użytkownika |
curl --location --request POST 'https://mvsep.com/api/app/disable_premium' --form 'api_token="<Twój token API>"'
| Klucz | Wartość |
|---|---|
| success |
|
| message | Informuje o statusie operacji |
API MVSEP stosuje następujące kody błędów:
| Kod Błędu | Znaczenie |
|---|---|
| 400 | Nieprawidłowy klucz API |
Aby włączyć długie nazwy plików dla użytkownika, musisz wykonać zapytanie POST do następującego adresu URL:
https://mvsep.com/api/app/enable_long_filenames
| Pole | Typ | Opis |
|---|---|---|
| api_token | String | Klucz API użytkownika |
curl --location --request POST 'https://mvsep.com/api/app/enable_long_filenames' --form 'api_token="<Twój token API>"'
| Klucz | Wartość |
|---|---|
| success |
|
| message | Informuje o statusie operacji |
API MVSEP stosuje następujące kody błędów:
| Kod Błędu | Znaczenie |
|---|---|
| 400 | Nieprawidłowy klucz API |
Aby wyłączyć długie nazwy plików dla użytkownika, musisz wykonać zapytanie POST do następującego adresu URL:
https://mvsep.com/api/app/disable_long_filenames
| Pole | Typ | Opis |
|---|---|---|
| api_token | String | Klucz API użytkownika |
curl --location --request POST 'https://mvsep.com/api/app/disable_long_filenames' --form 'api_token="<Twój token API>"'
| Klucz | Wartość |
|---|---|
| success |
|
| message | Informuje o statusie operacji |
API MVSEP stosuje następujące kody błędów:
| Kod Błędu | Znaczenie |
|---|---|
| 400 | Nieprawidłowy klucz 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
| Pole | Typ | Opis |
|---|---|---|
| start | Integer | (opcjonalnie) Punkt początkowy, domyślnie 0 (tzn. zaczyna od najnowszych) |
| limit | Integer | (opcjonalnie) Maksymalna liczba zwracanych wyników, domyślnie 10, maksymalnie 20 |
curl --location --request GET 'https://mvsep.com/api/quality_checker/queue?&start=1&limit=2'
Zwraca dane w postaci tablicy:
| Klucz | Wartość |
|---|---|
| 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
| Pole | Typ | Opis |
|---|---|---|
| dataset_type | String | Dataset Type, defaults to 0 if not given
|
| start | Integer | (opcjonalnie) Punkt początkowy, domyślnie 0 (tzn. zaczyna od najnowszych) |
| limit | Integer | (opcjonalnie) Maksymalna liczba zwracanych wyników, domyślnie 10, maksymalnie 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'
| Klucz | Wartość |
|---|---|
| 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
| Pole | Typ | Opis |
|---|---|---|
| api_token | String | (required) Twój klucz 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"'
| Klucz | Wartość |
|---|---|
| success |
|
| data | Contains information about entry |
| data -> id | ID of the entry. |
| data -> link | Link to the entry. |
API MVSEP stosuje następujące kody błędów:
| Kod Błędu | Znaczenie |
|---|---|
| 400 | Formularz jest nieprawidłowy |
| 401 |
Nieznany lub niepoprawny api_token. Ten błąd występuje, jeśli używasz nieznanego klucza 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
| Pole | Typ | Opis |
|---|---|---|
| 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
| Pole | Typ | Opis |
|---|---|---|
| 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"'
| Klucz | Wartość |
|---|---|
| success |
|
| data->message | Shows whether entry was deleted |
turbo@mvsep.com