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.
Należy pamiętać, że użytkownicy Premium mogą żądać nieograniczonej liczby równoczesnych zadań, natomiast użytkownicy pozostałych kont mogą żądać tylko jednego równoczesnego zadania.
MVSEP obsługuje regionalne punkty końcowe API. Wszystkie regiony korzystają z jednej bazy danych kont, więc to samo konto, klucz API i skróty zadań działają wszędzie:
https://de.mvsep.com/apihttps://de2.mvsep.com/apihttps://hk.mvsep.com/apiŻądania kierowane na https://mvsep.com/api są kierowane geograficznie: użytkownicy z Europy trafiają do de, użytkownicy z Azji Północnej do hk, a wszyscy pozostali do de2. W przypadku integracji z API zalecamy jawne wywoływanie regionalnego punktu końcowego — dzięki temu cały cykl życia zadania odbywa się na jednym hoście, niezależnie od tego, skąd pochodzą żądania.
Każda separacja jest przetwarzana i przechowywana w regionie, w którym została utworzona, a adresy URL do pobrania zwracane w odpowiedziach zawsze wskazują na serwer tego regionu. Aby uzyskać najlepszą wydajność, wybierz punkt końcowy położony najbliżej Twoich serwerów i korzystaj z tego samego serwera przez cały cykl życia zadania — podczas tworzenia, sprawdzania statusu oraz pobierania plików.
Można sprawdzić status dowolnego zadania z dowolnego regionu (baza danych jest wspólna), ale same pliki wyjściowe są zawsze udostępniane przez region, do którego należy dane zadanie.
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 | Ciąg | Twój klucz API |
| audiofile | Binarny | Plik audio do przetworzenia. Nie jest wymagany, jeśli ustawiono parametr url lub model nie korzysta z pliku wejściowego. W przypadku modeli dopasowujących użyj target_audiofile i reference_audiofile jako danych wejściowych zamiast audiofile. |
| url | Ciąg | Link do pliku audio. Nie jest wymagany, jeśli ustawiony jest parametr audiofile. |
| remote_type | Ciąg | (opcjonalnie) Zdalny typ pliku audio. Domyślnie direct. Nie jest wymagany, jeśli ustawiony jest parametr audiofile. Obsługiwane typy to direct (bezpośrednie pobieranie), mega (MEGA), drive (Dysk Google), dropbox (Dropbox). |
| sep_type | Liczba całkowita | (opcjonalnie) Typ separacji, domyślnie 20. Jest to identyfikator typu separacji — więcej informacji znajdziesz w sekcji GET SEPARATION TYPES. Ignorowany, gdy podano <code class="higlighted">preset_id</code>. |
| preset_id | Liczba całkowita | (opcjonalnie) Zastosuj do pliku jeden ze swoich zapisanych presetów zamiast pojedynczego algorytmu. Podaj albo sep_type, albo preset_id — preset definiuje własne algorytmy, opcje i formaty wyjściowe, więc sep_type, pola add_opt oraz output_format są w tym przypadku ignorowane. Odpowiedź zwraca hash, który odpytujesz dokładnie tak samo jak w przypadku separacji; wynik zawiera jeden wpis na każdy węzeł wyjściowy presetu. Identyfikatory znajdziesz w tabeli presetów poniżej. |
| add_opt1 | Ciąg | (opcjonalnie) Pierwsze dodatkowe pole typu separacji |
| add_opt2 | Ciąg | (opcjonalnie) Drugie dodatkowe pole typu separacji |
| add_opt3 | Ciąg | (opcjonalnie) Trzecie dodatkowe pole typu separacji |
| output_format | Liczba całkowita | (opcjonalnie) format wyjściowy, domyślnie 0 (mp3 (320kbps)) |
| is_demo | Wartość logiczna | (opcjonalnie) czy separacja ma zostać opublikowana na stronie demo, domyślnie false |
| webhook_url | Ciąg | (opcjonalnie) Adres URL, na który wyślemy metodą POST gotowy wynik, dzięki czemu nie musisz ciągle odpytywać. Treść to ten sam JSON co w GET SEPARATION. Nadpisuje to adres ustawiony dla całego konta na stronie webhooków, co jest przydatne, gdy kilku Twoich własnych użytkowników korzysta z jednego tokenu API. Musi to być publicznie dostępny adres http lub https. |
| Nazwa | Wartość | Pola dodatkowe |
|---|---|---|
| Ensemble (vocals, instrum) | 26 | Klucz: add_opt1 Nazwa: Output files Opcje:
Klucz: add_opt2 Nazwa: Model Type Opcje:
|
| Ensemble (vocals, instrum, bass, drums, other) | 28 | Klucz: add_opt1 Nazwa: Output files Opcje:
Klucz: add_opt2 Nazwa: Model Type Opcje:
|
| Ensemble All-In (vocals, bass, drums, piano, guitar, lead/back vocals, other) | 30 | Klucz: add_opt1 Nazwa: Output files Opcje:
Klucz: add_opt2 Nazwa: Model Type Opcje:
|
| BS Roformer SW (vocals, bass, drums, guitar, piano, other) | 63 | |
| Demucs4 HT (vocals, drums, bass, other) | 20 | Klucz: add_opt1 Nazwa: Model type Opcje:
|
| BS Roformer (vocals, instrumental) | 40 | Klucz: add_opt1 Nazwa: Vocal model type Opcje:
Klucz: add_opt2 Nazwa: Overlap Opcje:
Klucz: add_opt3 Nazwa: Set of stems Opcje:
|
| BS PolarFormer (vocals, instrumental) | 123 | Klucz: add_opt1 Nazwa: Model type Opcje:
Klucz: add_opt2 Nazwa: Overlap Opcje:
|
| MelBand Roformer (vocals, instrumental) | 48 | Klucz: add_opt1 Nazwa: Vocal model type Opcje:
Klucz: add_opt2 Nazwa: Overlap Opcje:
|
| MDX23C (vocals, instrumental) | 25 | Klucz: add_opt1 Nazwa: Vocal model type Opcje:
|
| SCNet (vocals, instrumental) | 46 | Klucz: add_opt1 Nazwa: Vocal model type Opcje:
|
| MDX B (vocals, instrumental) | 23 | Klucz: add_opt1 Nazwa: Vocal model type Opcje:
|
| Ultimate Vocal Remover VR (vocals, music) | 9 | Klucz: add_opt1 Nazwa: Model Type Opcje:
Klucz: add_opt2 Nazwa: Agressiveness Opcje:
|
| Demucs4 Vocals 2023 (vocals, instrum) | 27 | |
| MVSep Karaoke (lead/back vocals) | 49 | Klucz: add_opt1 Nazwa: Karaoke model type Opcje:
Klucz: add_opt2 Nazwa: Extraction type Opcje:
|
| MDX-B Karaoke (lead/back vocals) | 12 | Klucz: add_opt1 Nazwa: Karaoke model type Opcje:
|
| MVSep Crowd removal (crowd, other) | 34 | Klucz: add_opt1 Nazwa: Model type Opcje:
|
| Medley Vox (Multi-singer separation) | 53 | Klucz: add_opt1 Nazwa: Model type Opcje:
|
| MVSep Multichannel BS (vocals, instrumental) | 43 | Klucz: add_opt1 Nazwa: Model Type Opcje:
Klucz: add_opt2 Nazwa: Processing Mode Opcje:
|
| MVSep Male/Female separation | 57 | Klucz: add_opt1 Nazwa: Model type Opcje:
Klucz: add_opt2 Nazwa: How to extract Opcje:
|
| MVSep Choir (choir, other) | 112 | Klucz: add_opt2 Nazwa: How to extract Opcje:
|
| MVSep SATB Choir (soprano, alto, tenor, bass) | 111 | Klucz: add_opt1 Nazwa: Model type Opcje:
Klucz: add_opt2 Nazwa: How to extract Opcje:
|
| MVSep Drums (drums, other) | 44 | Klucz: add_opt1 Nazwa: Drums model type Opcje:
Klucz: add_opt2 Nazwa: How to extract Opcje:
Klucz: add_opt3 Nazwa: Output files Opcje:
|
| MVSep Bass (bass, other) | 41 | Klucz: add_opt1 Nazwa: Bass model type Opcje:
Klucz: add_opt2 Nazwa: How to extract Opcje:
Klucz: add_opt3 Nazwa: Output files Opcje:
|
| MVSep Synth (synth, other) | 88 | Klucz: add_opt1 Nazwa: How to extract Opcje:
|
| DrumSep (4-6 stems: kick, snare, cymbals, toms, ride, hh, crash) | 37 | Klucz: add_opt1 Nazwa: Model Type Opcje:
Klucz: add_opt2 Nazwa: Preprocess Opcje:
|
| MVSep Piano (piano, other) | 29 | Klucz: add_opt1 Nazwa: Piano model type Opcje:
|
| MVSep Digital Piano (digital-piano, other) | 79 | Klucz: add_opt2 Nazwa: How to extract Opcje:
|
| MVSep Keys (keys, other) | 106 | |
| MVSep Organ (organ, other) | 58 | Klucz: add_opt1 Nazwa: Organ model type Opcje:
|
| MVSep Harpsichord (harpsichord, other) | 91 | |
| MVSep Accordion (accordion, other) | 99 | |
| MVSep Vibraphone | 129 | |
| MVSep Metal Bars | 130 | |
| MVSep Rhodes | 131 | |
| MVSep Clavinet | 135 | |
| MVSep Mellotron | 136 | |
| MVSep Guitar (guitar, other) | 31 | Klucz: add_opt1 Nazwa: Guitar model type Opcje:
|
| MVSep Acoustic Guitar (acoustic-guitar, other) | 66 | Klucz: add_opt2 Nazwa: How to extract Opcje:
|
| MVSep Electric Guitar (electric-guitar, other) | 81 | Klucz: add_opt2 Nazwa: How to extract Opcje:
|
| MVSep Lead/Rhythm Guitar (lead-guitar, rhythm-guitar) | 101 | Klucz: add_opt1 Nazwa: Model type Opcje:
|
| 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 | Klucz: add_opt1 Nazwa: String model type Opcje:
Klucz: add_opt2 Nazwa: How to extract Opcje:
|
| MVSep Violin (violin, other) | 65 | |
| MVSep Viola (viola, other) | 69 | Klucz: add_opt2 Nazwa: How to extract Opcje:
|
| MVSep Cello (cello, other) | 70 | Klucz: add_opt2 Nazwa: How to extract Opcje:
|
| MVSep Double Bass (double-bass, other) | 73 | Klucz: add_opt2 Nazwa: How to extract Opcje:
|
| MVSep Wind (wind, other) | 54 | Klucz: add_opt1 Nazwa: Wind model type Opcje:
Klucz: add_opt2 Nazwa: How to extract Opcje:
Klucz: add_opt3 Nazwa: Output files Opcje:
|
| MVSep Brass (brass, other) | 107 | Klucz: add_opt1 Nazwa: How to extract Opcje:
|
| MVSep Woodwind (woodwind, other) | 108 | Klucz: add_opt1 Nazwa: How to extract Opcje:
|
| MVSep Saxophone (saxophone, other) | 61 | Klucz: add_opt1 Nazwa: Model type Opcje:
|
| MVSep Flute (flute, other) | 67 | Klucz: add_opt1 Nazwa: Flute model type Opcje:
Klucz: add_opt2 Nazwa: How to extract Opcje:
|
| MVSep Trumpet (trumpet, other) | 71 | Klucz: add_opt2 Nazwa: How to extract Opcje:
|
| MVSep Trombone (trombone, other) | 75 | Klucz: add_opt2 Nazwa: How to extract Opcje:
|
| MVSep Oboe (oboe, other) | 77 | Klucz: add_opt2 Nazwa: How to extract Opcje:
|
| MVSep Clarinet (clarinet, other) | 78 | Klucz: add_opt2 Nazwa: How to extract Opcje:
|
| MVSep French Horn (french-horn, other) | 82 | Klucz: add_opt2 Nazwa: How to extract Opcje:
|
| MVSep Harmonica (harmonica, other) | 87 | Klucz: add_opt2 Nazwa: How to extract Opcje:
|
| MVSep Tuba (tuba, other) | 92 | |
| MVSep Bassoon (bassoon, other) | 93 | |
| MVSep Bagpipes (bagpipes , other) | 116 | Klucz: add_opt2 Nazwa: How to extract Opcje:
|
| MVSep Whistle | 132 | |
| 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 | Klucz: add_opt2 Nazwa: How to extract Opcje:
|
| MVSep Celesta (celesta, other) | 110 | Klucz: add_opt2 Nazwa: How to extract Opcje:
|
| MVSep Clap | 133 | |
| MVSep Cowbell | 128 | |
| MVSep Demucs4HT DNR (speech, music, effects) | 24 | Klucz: add_opt1 Nazwa: Model type Opcje:
|
| BandIt Plus (speech, music, effects) | 36 | |
| BandIt v2 (speech, music, effects) | 45 | Klucz: add_opt1 Nazwa: Model Type Opcje:
|
| MVSep DnR v3 (speech, music, effects) | 56 | Klucz: add_opt1 Nazwa: Model type Opcje:
Klucz: add_opt2 Nazwa: How to extract Opcje:
Klucz: add_opt3 Nazwa: Output files Opcje:
|
| MVSep Braam | 117 | |
| MVSep Risers | 125 | |
| MVSep FX | 122 | |
| Apollo Enhancers (by JusperLee, Lew, baicai1145) | 51 | Klucz: add_opt1 Nazwa: Model type Opcje:
Klucz: add_opt2 Nazwa: Cutoff (Hz) Opcje:
|
| Reverb Removal (noreverb) | 22 | Klucz: add_opt1 Nazwa: Model Type Opcje:
Klucz: add_opt2 Nazwa: Preprocess Opcje:
|
| DeNoise by aufr33 and gabox | 47 | Klucz: add_opt1 Nazwa: Model type Opcje:
|
| AudioSR (Super Resolution) | 59 | Klucz: add_opt1 Nazwa: Cutoff (Hz) Opcje:
|
| FlashSR (Super Resolution) | 60 | |
| Stable Audio Open Gen | 62 | Klucz: add_opt1 Nazwa: Text prompt Opcje: Klucz: add_opt2 Nazwa: Length (in seconds) Opcje:
|
| Whisper (extract text from audio) | 39 | Klucz: add_opt1 Nazwa: Model type Opcje:
Klucz: add_opt2 Nazwa: Transcription type Opcje:
|
| Parakeet (extract text from audio) | 64 | Klucz: add_opt1 Nazwa: Model type Opcje:
Klucz: add_opt2 Nazwa: Version Opcje:
|
| VibeVoice (Voice Cloning) | 103 | Klucz: add_opt1 Nazwa: Model type Opcje:
Klucz: add_opt2 Nazwa: Text prompt Opcje: Klucz: add_opt3 Nazwa: Extract vocals first Opcje:
|
| VibeVoice (TTS) | 104 | Klucz: add_opt1 Nazwa: Model type Opcje:
Klucz: add_opt2 Nazwa: Text prompt Opcje: |
| Qwen3-TTS (Custom Voice) | 118 | Klucz: add_opt1 Nazwa: Text prompt Opcje: Klucz: add_opt2 Nazwa: Speaker Opcje:
Klucz: add_opt3 Nazwa: Language Opcje:
Klucz: add_opt4 Nazwa: Voice description Opcje: |
| Qwen3-TTS (Voice Design) | 119 | Klucz: add_opt1 Nazwa: Text prompt Opcje: Klucz: add_opt2 Nazwa: Voice description Opcje: Klucz: add_opt3 Nazwa: Language Opcje:
|
| Qwen3-TTS (Voice Cloning) | 120 | Klucz: add_opt1 Nazwa: Text prompt Opcje: Klucz: add_opt2 Nazwa: Reference text in audio (optional) Opcje: Klucz: add_opt3 Nazwa: Language Opcje:
Klucz: add_opt4 Nazwa: Extract vocals first Opcje:
|
| Mega 53-stem Model | 126 | |
| Upmixing by Jazzpear | 137 | |
| DeEffect vocals by gilliaan | 138 | |
| Bark (Speech Gen) | 115 | Klucz: add_opt1 Nazwa: Text prompt Opcje: Klucz: add_opt2 Nazwa: Speaker Opcje:
|
| MVSep MultiSpeaker (MDX23C) | 42 | Klucz: add_opt1 Nazwa: Model Type Opcje:
|
| Aspiration (by Sucial) | 50 | Klucz: add_opt1 Nazwa: Model type Opcje:
|
| Phantom Centre extraction | 55 | Klucz: add_opt1 Nazwa: Model type Opcje:
|
| Matchering (by sergree) | 68 | |
| SOME (Singing-Oriented MIDI Extractor) | 80 | Klucz: add_opt1 Nazwa: How to use Opcje:
|
| Transkun (Piano -> MIDI) | 113 | Klucz: add_opt1 Nazwa: How to extract Opcje:
|
| Basic Pitch (MIDI Extraction) | 114 | |
| ADTOF Plus (Drums -> MIDI) | 127 | Klucz: add_opt1 Nazwa: How to extract Opcje:
|
| HeartMuLa (Song Gen) | 121 | Klucz: add_opt1 Nazwa: Lyrics Opcje: Klucz: add_opt10 Nazwa: Topic Opcje:
Klucz: add_opt2 Nazwa: Tags (optional) Opcje: Klucz: add_opt3 Nazwa: Genre Opcje:
Klucz: add_opt4 Nazwa: Timbre Opcje:
Klucz: add_opt5 Nazwa: Gender Opcje:
Klucz: add_opt6 Nazwa: Mood Opcje:
Klucz: add_opt7 Nazwa: Instrument Opcje:
Klucz: add_opt8 Nazwa: Scene Opcje:
Klucz: add_opt9 Nazwa: Region Opcje:
|
| Demucs3 Model (vocals, drums, bass, other) | 10 | Klucz: add_opt1 Nazwa: Model type Opcje:
|
| MDX A/B (vocals, drums, bass, other) | 7 | Klucz: add_opt1 Nazwa: Vocal model type Opcje:
|
| Vit Large 23 (vocals, instrum) | 33 | Klucz: add_opt1 Nazwa: Model type Opcje:
|
| UVRv5 Demucs (vocals, music) | 17 | Klucz: add_opt1 Nazwa: Model Type Opcje:
|
| 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 | Klucz: add_opt1 Nazwa: Model type Opcje:
|
| UnMix | 3 | Klucz: add_opt1 Nazwa: Model type Opcje:
|
| Zero Shot (Query Based) (Low quality) | 14 | Klucz: add_opt1 Nazwa: Model Type Opcje:
|
| LarsNet (kick, snare, cymbals, toms, hihat) | 38 | Klucz: add_opt1 Nazwa: Model type Opcje:
|
Presety są prywatne dla konta, na którym zostały utworzone, więc w tej tabeli widoczne są Twoje presety oraz te wyselekcjonowane przez nas. Tworzysz i edytujesz je w edytorze presetów.
Nie masz jeszcze żadnych presetów. Zaloguj się i utwórz preset w edytorze presetów, a jego identyfikator pojawi się tutaj.
| 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 link do adresu "POBIERZ 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
Ten sam punkt końcowy zwraca przebiegi z presetów: sprawdzaj hash otrzymany z preset_id dokładnie tak samo, jak w przypadku separacji. Struktura jest identyczna — status przechodzi przez waiting i processing do done — a data.type ma wartość preset_run. Każdy wpis w data.files stanowi jeden węzeł wyjściowy presetu, nazwany według swojej etykiety, a nie według stemu. Przebieg jest widoczny wyłącznie dla konta, które go utworzyło.
| Pole | Typ | Opis |
|---|---|---|
| hash | Ciąg | Hash separacji |
| mirror | Liczba całkowita | (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 | Ciąg | (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 status |
| 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) |
Usuń jedną ze swoich separacji — zwykłe zadanie lub uruchomienie z presetu. Spowoduje to usunięcie rekordu i jego plików wyjściowych. Separację, która jest jeszcze przetwarzana, należy najpierw anulować. Usunięcie nie zwraca kredytów, ponieważ praca została już wykonana.
POST https://mvsep.com/api/separation/delete
Można sprawdzić status dowolnego zadania z dowolnego regionu (baza danych jest wspólna), ale same pliki wyjściowe są zawsze udostępniane przez region, do którego należy dane zadanie.
| Pole | Typ | Opis |
|---|---|---|
| hash | Ciąg | Hash separacji |
| api_token | Ciąg | Klucz API użytkownika. Wymagany. |
curl --location --request POST 'https://mvsep.com/api/separation/delete'
--form 'api_token="<Twój token API>"'
--form 'hash="20230327071601-0e3e5c6c85-13-dimensions.mp3"'
| Klucz | Wartość |
|---|---|
| success |
|
| data -> message | Wyświetla opis stanu (dotyczy wszystkich statusów ale jeżeli pole status ma wartość failed - zawiera wtedy powód błędu). |
Aby uzyskać wynik zadania zdalnego, należy wykonać wywołanie GET na następujący adres URL:
https://mvsep.com/api/separation/get-remote
| Pole | Typ | Opis |
|---|---|---|
| hash | Ciąg | Hash 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 status |
| data -> queue_count | Pokazuje liczbę nieprzetworzonych zadań według priorytetu użytkownika (wyświetlane tylko wtedy, gdy status to waiting). |
| data -> current_order | Pokazuje kolejność zadań użytkownika (wyświetlane tylko wtedy, gdy status to waiting). |
| data -> message | Wyświetla opis statusu (tylko gdy status to failed). |
| data -> link | Pokazuje link do adresu URL "POBIERZ WYNIK" utworzonego zadania (wyświetlany tylko wtedy, gdy status to done). |
| data -> hash | Skrót separacji (wyświetlany tylko wtedy, gdy status ma wartość done). |
Aby anulować separację i zwrócić wykorzystane środki (jeśli separacja nie jest jeszcze przetwarzana), należy wykonać wywołanie POST na następujący adres URL:
https://mvsep.com/api/separation/cancel
| Pole | Typ | Opis |
|---|---|---|
| api_token | Ciąg | Klucz API użytkownika |
| hash | Ciąg | Hash separacji |
curl --location --request POST 'https://mvsep.com/api/separation/cancel' --form 'api_token="<Twój token API>"' --form 'hash="<hash>"'
| Klucz | Wartość |
|---|---|
| success |
|
Aby uzyskać szczegółowe dane o typach separacji, należy wykonać wywołanie GET na następujący adres URL:
https://mvsep.com/api/app/algorithms
| Pole | Typ | Opis |
|---|---|---|
| scopes | Ciąg | Czy uwzględniać modele wykorzystujące różne formy danych wejściowych.
single_upload, jeśli nie podano. Aby pobrać wszystkie modele, ustaw scopes=single_upload,no_upload,matchering_upload.
|
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 |
| algorithm_group | Zawiera informacje o grupie algorytmów, do której należy dany algorytm. |
| algorithm_group -> name | Nazwa grupy algorytmów. |
| audio_widget |
Typ widżetu audio używanego w algorytmie. Można go użyć do określenia sposobu wyświetlania odtwarzacza audio dla algorytmu w interfejsie użytkownika. Możliwe wartości to:
|
| 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 | Pokazuje miesięczną liczbę użyć typu separacji |
| rating | Pokazuje miesięczną ocenę wykorzystania typu separacji jako tablicę:
|
| algorithm_fields | Zawiera informacje o dodatkowych polach typu separacji |
| algorithm_fields -> name |
Wskazuje, które dodatkowe 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. Jeden 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 | Ciąg | (opcjonalnie) 2-literowy kod języka (en, ru) |
| start | Liczba całkowita | (opcjonalnie) Punkt początkowy, domyślnie 0 (tzn. zaczyna od najnowszych) |
| limit | Liczba całkowita | (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 |
Aby uzyskać informacje o kolejce witryny, należy wykonać wywołanie GET na następujący adres URL:
https://mvsep.com/api/app/queue
| Pole | Typ | Opis |
|---|---|---|
| api_token | Ciąg | (opcjonalny) Klucz API użytkownika |
curl --location --request GET 'https://mvsep.com/api/app/queue'
| Klucz | Wartość |
|---|---|
| queue |
Zawiera tablicę bieżących kolejek dla różnych planów:
|
| plan |
Zawiera bieżącą kolejkę dla bieżącego planu (dodaj api_token do żądania zarejestrowanego/premium planu):
|
Gdzie w kolejce znajdują się Twoje zadania. Użyj tego zamiast zgadywania czasu oczekiwania: zwraca to, co jest w kolejce dla Twojego konta, co już jest przetwarzane, ile zadań znajduje się przed Twoim najstarszym oczekującym zadaniem oraz ostrożnie oszacowany czas w sekundach. Jest na tyle tanie, że możesz odpytywać je w takim samym interwale jak punkt końcowy statusu separacji.
https://mvsep.com/api/app/queue/summary
| Pole | Typ | Opis |
|---|---|---|
| api_token | Ciąg | (wymagany) Klucz API użytkownika |
curl --location --request GET 'https://mvsep.com/api/app/queue/summary?api_token=<Twój token API>'
| Klucz | Wartość |
|---|---|
| queued | Twoje zadania oczekujące na workera. |
| processing | Twoje zadania aktualnie przetwarzane na GPU. |
| ahead | Zadania przed Twoim najstarszym oczekującym zadaniem, liczone w obrębie Twojego poziomu. |
| estimated_wait_seconds | Szacowana liczba sekund do rozpoczęcia Twojego najstarszego oczekującego zadania. Celowo ostrożna. null, gdy nie da się jej zmierzyć — nie masz nic w kolejce albo ostatnia aktywność była zbyt mała, aby wyznaczyć tempo. Traktuj null jako „nieznane”, nigdy jako „teraz”. |
| throughput_per_min | Liczba zadań pobieranych na minutę w całej flocie, mierzona w ostatnim okresie, a nie ustawiona na stałe. |
Zasady kolejkowania stojące za tymi liczbami — kolejność poziomów, sposób dzielenia mocy obliczeniowej między konta premium oraz to, co decyduje o czasie oczekiwania — opisuje Jak działa kolejka.
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 | Liczba całkowita | (opcjonalnie) Punkt początkowy, domyślnie 0 (tzn. zaczyna od najnowszych) |
| limit | Liczba całkowita | (opcjonalnie) Maksymalna liczba zwracanych wyników, domyślnie 10, maksymalnie 20 |
| algorithm_id | Liczba całkowita | Opcjonalny identyfikator typu separacji. Użyj tego, aby zwrócić separacje demonstracyjne utworzone tylko przez jeden algorytm. Wartości pasują do render_id z punktu końcowego GET SEPARATION TYPES. |
| options[FIELD] | Ciąg / Liczba całkowita | Opcjonalny filtr dla wartości opcji algorytmu. Zastąp FIELD dodatkowym kluczem pola z algorithm_fields -> name w odpowiedzi GET SEPARATION TYPES, a następnie przekaż jeden z kluczy options tego pola jako wartość. Przykład: options[vocals]=1. |
| additional_options | Ciąg | Opcjonalny surowy filtr typu „zawiera” działający na zapisanych danych opcji zadania. W nowych integracjach lepiej używać options[FIELD], ponieważ jest jednoznaczny i łatwiejszy do złożenia. |
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'
Aby utworzyć filtry opcji, najpierw wywołaj https://mvsep.com/api/app/algorithms i sprawdź listę algorithm_fields każdego algorytmu. Użyj pola name wewnątrz options[FIELD] i użyj jednego z kluczy opcji JSON jako wartości.
Zwraca dane w postaci tablicy:
| Klucz | Wartość |
|---|---|
| hash | Hash separacji |
| date | Data separacji |
| input_audio | URL audio wejściowego |
| size | Rozmiar audio wejściowego |
| algorithm | Zawiera podstawowe informacje o użytym typie separacji (informacje o zwracanych parametrach znajdziesz w zakładce GET SEPARATION TYPES) |
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 | Ciąg | Nazwa użytkownika |
| Ciąg | Email użytkownika | |
| password | Ciąg | Hasło użytkownika |
| password_confirmation | Ciąg | 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 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 |
|---|---|---|
| Ciąg | Email użytkownika | |
| password | Ciąg | 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 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 | Ciąg | 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 | Ciąg | Klucz API użytkownika |
| start | Liczba całkowita | (opcjonalnie) Punkt początkowy, domyślnie 0 (tzn. zaczyna od najnowszych) |
| limit | Liczba całkowita | (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 | Hash separacji |
| data -> job_exists | Zawiera tablicę podstawowych informacji o wcześniejszych separacjach |
| data -> credits | Ile kredytów pochłonęło zadanie; null, jeśli separacja już nie istnieje |
| data -> time_left | Przybliżony czas pozostały do usunięcia zadania |
| data -> algorithm | Zawiera podstawowe informacje o użytym typie separacji (informacje o zwracanych parametrach znajdziesz w zakładce GET SEPARATION TYPES) |
API MVSEP stosuje następujące kody błędów:
| Kod Błędu | Znaczenie |
|---|---|
| 400 | Nieprawidłowy klucz API |
Aby pobrać zakupy kredytów dokonane na tym koncie, od najnowszych, należy wykonać wywołanie GET na następujący adres URL:
https://mvsep.com/api/purchases
| Pole | Typ | Opis |
|---|---|---|
| api_token | Ciąg | Klucz API użytkownika |
| limit | Liczba całkowita | (opcjonalnie) Ile zakupów zwrócić, 1–100. Wartość domyślna to 20. |
| offset | Liczba całkowita | (opcjonalnie) Liczba transakcji, które mają zostać pominięte podczas przeglądania historii. Domyślna wartość to 0. |
| status | Ciąg | (opcjonalnie) Zwraca tylko transakcje zakupu w tym stanie, np. succeeded. Pomiń to (lub podaj all), aby uzyskać wszystkie pozycje wyświetlane na stronie historii serwisu, w tym transakcje, które zostały rozpoczęte, ale nigdy nie zostały sfinalizowane — mają one status unpaid i nie przyznano za nie żadnych kredytów. |
curl --location --request GET 'https://mvsep.com/api/purchases?api_token=<Twój token API>&status=succeeded&limit=20'
| Klucz | Wartość |
|---|---|
| purchases | Jeden wpis na każdy zakup: payment_id, status, amount, przyznane credits, payment_method (stripe, paddle, yookassa, google_play lub app_store) oraz date. |
| total | Ile w sumie jest pasujących zakupów, z pominięciem limit i offset — wykorzystaj tę liczbę do stronicowania. |
| credits | Bieżące saldo kredytów na koncie. |
MVSEP wysyła wiadomość e-mail, gdy saldo kredytowe spadnie do wybranego przez użytkownika progu, dzięki czemu działająca integracja nie zostanie nieoczekiwanie zatrzymana. Polecenie GET zwraca aktualne ustawienie; polecenie POST zmienia je. Powiadomienie jest wysyłane jednorazowo i nie powtarza się, dopóki saldo nie wzrośnie ponownie powyżej progu.
GET https://mvsep.com/api/credit_alert
POST https://mvsep.com/api/credit_alert
| Pole | Typ | Opis |
|---|---|---|
| api_token | Ciąg | Klucz API użytkownika |
| credit_threshold | Liczba całkowita | (Tylko POST, wymagane) Wyślij powiadomienie, gdy saldo osiągnie lub spadnie poniżej tej liczby kredytów. 0 wyłącza powiadomienie. Zmiana progu ponownie uzbraja alert, który został już wysłany. |
curl --location --request GET 'https://mvsep.com/api/credit_alert?api_token=<Twój token API>'
curl --location --request POST 'https://mvsep.com/api/credit_alert' --form 'api_token=<Twój token API>' --form 'credit_threshold=100'
| Klucz | Wartość |
|---|---|
| credit_threshold | Obecnie ustalony próg, wyrażony w kredytach. |
| enabled | <code>true</code>, jeśli ustawiono próg powyżej zera, w przeciwnym razie <code>false</code>. |
| credits | Bieżące saldo kredytów na koncie. |
| notified | <code>true</code> po wysłaniu alertu o bieżącym spadku; kasuje się samoczynnie, gdy saldo ponownie przekroczy próg. |
| Adres, na który wysyłany jest alert. |
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 | Ciąg | 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 | Ciąg | 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 | Ciąg | 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 | Ciąg | 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 |
Aby uzyskać informacje o wpisach w kolejce Quality Checker, należy wykonać wywołanie GET na następujący adres URL:
https://mvsep.com/api/quality_checker/queue
| Pole | Typ | Opis |
|---|---|---|
| start | Liczba całkowita | (opcjonalnie) Punkt początkowy, domyślnie 0 (tzn. zaczyna od najnowszych) |
| limit | Liczba całkowita | (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 | Numer identyfikacyjny wpisu |
| dataset_type | Typ zbioru danych wybrany podczas dodawania wpisu/typu tabeli wyników
|
| date | Data utworzenia wpisu |
| algo_name | Nazwa użytego typu/algorytmu separacji |
| main_text | Opis zastosowanego typu/algorytmu separacji |
| proc | Status przetwarzania
|
| proc_remote_date | Znak czasu daty przetwarzania |
| msg | Zwraca „OK”, jeśli operacja się powiedzie, w przeciwnym razie wyświetla komunikat o błędzie |
| metrics | Informacje o metrykach wpisu |
| sdr_* (wildcard) | SDR odpowiadających stemów |
| dataset_name | Nazwa zestawu danych |
Aby uzyskać informacje o rankingach Quality Checker, należy wykonać wywołanie GET na następujący adres URL:
https://mvsep.com/api/quality_checker/leaderboard
| Pole | Typ | Opis |
|---|---|---|
| dataset_type | Ciąg | Typ zbioru danych, domyślnie 0, jeśli nie podano.
|
| start | Liczba całkowita | (opcjonalnie) Punkt początkowy, domyślnie 0 (tzn. zaczyna od najnowszych) |
| limit | Liczba całkowita | (opcjonalnie) Maksymalna liczba zwracanych wyników, domyślnie 10, maksymalnie 20 |
| algo_name_filter | Ciąg | Filtruje nazwy typów separacji/algorytmów według podanego tekstu |
| sort | Ciąg | Sortuj według podanego SDR stemu. Listę wartości sortowalnych dla danego typu zbioru danych można uzyskać z klucza sortables w odpowiedzi. |
curl --location --request GET 'https://mvsep.com/api/quality_checker/leaderboard?&start=1&limit=2&algo_name_filter=MVSep'
| Klucz | Wartość |
|---|---|
| data | Zawiera tablicę wpisów Quality Checkera. Więcej informacji znajdziesz w odpowiedzi GET QUEUE w sekcji Quality Checker. |
| dataset_type | Użyty klucz typu zestawu danych |
| sortables | Klucze, których można użyć do posortowania użytego typu zbioru danych według podanego stemu. |
| sort | Użyty klucz sortowania z listy <code>sortables</code>. |
Aby utworzyć wpis do modułu Quality Checker, należy wykonać wywołanie POST do następującego adresu URL:
https://mvsep.com/api/quality_checker/add
| Pole | Typ | Opis |
|---|---|---|
| api_token | Ciąg | (wymagany) Twój klucz API |
| zipfile | Binarny | (wymagany) Plik zip do przetworzenia |
| algo_name | Ciąg | (wymagany) Nazwa algorytmu |
| main_text | Ciąg | (wymagany) Opis algorytmu |
| dataset_type | Ciąg | Typ zbioru danych. Domyślnie 0.
|
| password | Ciąg | (wymagany) Hasło do usunięcia algorytmu |
| ensemble | Liczba całkowita | 0 - algorytm nie jest zespołem. 1 - algorytm jest zespołem. |
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 | Zawiera informacje o wpisie |
| data -> id | ID wpisu |
| data -> link | Link do wpisu |
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
|
Aby uzyskać informacje o wpisie w kolejce Quality Checker według identyfikatora, należy wykonać wywołanie GET do następującego adresu URL:
https://mvsep.com/api/quality_checker/entry
| Pole | Typ | Opis |
|---|---|---|
| id | Liczba całkowita | (wymagany) ID wpisu |
curl --location --request GET 'https://mvsep.com/api/quality_checker/entry?id=7675'
Aby usunąć wpis w kolejce Quality Checker według identyfikatora i hasła, należy wykonać wywołanie GET do następującego adresu URL:
https://mvsep.com/api/quality_checker/delete
| Pole | Typ | Opis |
|---|---|---|
| id | Liczba całkowita | (wymagany) ID wpisu |
| password | Ciąg | (wymagany) Hasło użyte dla tego wpisu |
curl --location 'https://mvsep.com/api/quality_checker/delete' --form 'id="7720"' --form 'password="test"'
| Klucz | Wartość |
|---|---|
| success |
|
| data->message | Pokazuje, czy wpis został usunięty |
Biblioteki, aplikacje i integracje zbudowane w oparciu o to API. Poza przypadkami wyraźnie zaznaczonymi są to projekty społeczności: nie są utrzymywane przez MVSEP i nie możemy za nie ręczyć.
Ta wersja jest udostępniana na PyPI pod nazwą mvsep-cli, a jako autora podaje MVSEP, co może sprawiać wrażenie, że jest to wersja oficjalna. Jest ona publikowana i utrzymywana przez stronę trzecią, a nie przez MVSEP, a repozytorium źródłowe, do którego zawiera link, nie istnieje. Wymaga podania tokenu API, więc przed wklejeniem tokenu warto zapoznać się z jej kodem źródłowym.
mvsep-cli: pypi.org/project/mvsep-cli
