API MVSEP menyediakan akses terprogram untuk membuat pemisahan, mengembalikan hasil, mendapatkan informasi situs, dan mengontrol kemampuan pengguna.
Untuk menggunakan API ini, Anda memerlukan Kunci API. Anda belum login, silakan login untuk mendapatkan token API Anda.
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
Perhatikan bahwa pengguna Premium dapat meminta hingga 10 pekerjaan bersamaan, sementara pengguna non-Premium hanya dapat meminta 1 pekerjaan bersamaan.
Untuk membuat pemisahan, Anda perlu membuat panggilan POST ke url berikut:
https://mvsep.com/api/separation/create
Bidang | Jenis | Deskripsi |
---|---|---|
api_token | String | Kunci API Anda |
audiofile | Binary | File audio yang akan diproses. 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 | (opsional) Jenis Pemisahan, default ke 11 (Demucs3 Model B (vokal, drum, bass, lainnya)) |
add_opt1 | String | (opsional) Pemisahan Jenis bidang tambahan pertama |
add_opt2 | String | (opsional) Pemisahan Jenis bidang tambahan kedua |
add_opt3 | String | Jenis Pemisahan bidang tambahan ketiga |
output_format | Integer | (opsional) format output, default ke 0 (mp3 (320kbps)) |
is_demo | Boolean | (opsional) jika pemisahan dipublikasikan ke halaman demo, defaultnya adalah false |
Nama | Nilai | 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 |
Nama | Nilai |
---|---|
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 Token Anda>"'
--form 'sep_type="9"'
--form 'add_opt1="0"'
--form 'add_opt2="1"'
--form 'output_format="1"'
--form 'is_demo="1"'
Kunci | Nilai |
---|---|
success |
|
data | Menyimpan informasi tambahan tergantung pada kunci sukses |
data -> link | Menampilkan tautan ke URL "DAPATKAN HASIL" dari pekerjaan yang dibuat (hanya ditampilkan ketika success bernilai true ) |
data -> hash | Menampilkan hash pekerjaan yang dibuat (hanya ditampilkan ketika success bernilai true ) |
data -> message | Menampilkan deskripsi kesalahan (hanya ditampilkan ketika success bernilai true ) |
API MVSEP menggunakan kode kesalahan berikut:
Kode Kesalahan | Arti |
---|---|
400 | Beberapa parameter hilang atau tidak valid. Kesalahan ini muncul ketika Anda tidak mengirimkan setiap parameter wajib atau mengirimkan parameter yang tidak valid. |
401 |
api_token tidak dikenal atau tidak valid. Kesalahan ini muncul jika Anda menggunakan kunci API yang tidak dikenal.
|
Untuk mendapatkan hasil pemisahan, Anda perlu membuat panggilan GET ke url berikut:
https://mvsep.com/api/separation/get
Bidang | Jenis | Deskripsi |
---|---|---|
hash | String | Hash Pemisahan |
mirror | Integer | (opsional) Menggunakan cermin lain jika disetel ke 1, default ke 0. Memerlukan api_token dan 1 kredit jika disetel ke 1. |
api_token | string | (opsional) Kunci API pengguna. Diperlukan jika parameter mirror ditetapkan ke 1. |
curl --location --request GET 'https://mvsep.com/api/separation/get?hash=20230327071601-0e3e5c6c85-13-dimensions.mp3'
Kunci | Nilai |
---|---|
success |
|
status |
|
data | Menyimpan informasi tambahan tergantung pada kunci status |
data -> queue_count | Menampilkan jumlah pekerjaan yang belum diproses berdasarkan prioritas pengguna (hanya ditampilkan saat status adalah menunggu atau mendistribusikan ) |
data -> current_order | Menunjukkan urutan pekerjaan pengguna (hanya ditampilkan ketika status adalah menunggu atau mendistribusikan ) |
data -> message | Menampilkan deskripsi status (ditampilkan pada semua status, menampilkan alasan kesalahan sebagai gantinya ketika status adalah gagal ) |
data -> algorithm | Menunjukkan algoritma yang digunakan pada pekerjaan (hanya ditampilkan ketika status adalah selesai ) |
data -> algorithm_description | Menampilkan detail algoritma yang digunakan pada pekerjaan (hanya ditampilkan saat status adalah selesai ) |
data -> output_format | Menampilkan format keluaran pekerjaan (hanya ditampilkan saat status adalah selesai ) |
data -> tags | Menampilkan tag meta audio (hanya ditampilkan saat status adalah done ) |
data -> input_file | Menampilkan detail unduhan audio input (hanya ditampilkan saat status adalah selesai ) |
data -> files | Menampilkan detail unduhan audio keluaran (hanya ditampilkan saat status adalah selesai ) |
data -> date | Menunjukkan tanggal pemrosesan pekerjaan (hanya ditampilkan saat status adalah selesai ) |
data -> finished_chunks | Menunjukkan jumlah bagian yang telah selesai dari suatu pekerjaan besar (hanya ditampilkan ketika status adalah distributing ) |
data -> all_chunks | Menunjukkan jumlah semua bagian dari pekerjaan besar (hanya ditampilkan ketika status adalah 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
Bidang | Jenis | Deskripsi |
---|---|---|
hash | String | Hash Pemisahan |
curl --location --request GET 'https://mvsep.com/api/separation/get-remote?hash=n2AwBjy4KsFZfqqR'
Kunci | Nilai |
---|---|
success |
|
status |
|
data | Menyimpan informasi tambahan tergantung pada kunci 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
Bidang | Jenis | Deskripsi |
---|---|---|
api_token | string | API key pengguna |
hash | string | Hash Pemisahan |
curl --location --request POST 'https://mvsep.com/api/separation/cancel' --form 'api_token="<API Token Anda>"' --form 'hash="<hash>"'
Kunci | Nilai |
---|---|
success |
|
Untuk mendapatkan data terperinci tentang jenis pemisahan, Anda perlu melakukan panggilan GET ke url berikut:
https://mvsep.com/api/app/algorithms
curl --location --request GET 'https://mvsep.com/api/app/algorithms'
Mengembalikan data sebagai array:
Kunci | Nilai |
---|---|
render_id | Nilai tipe pemisahan (ID) |
name | Nama jenis pemisahan |
algorithm_group_id |
Kelompok tempat tipe pemisahan berada:
|
orientation |
Untuk siapa jenis pemisahan ini ditujukan:
|
order_id | Urutan jenis pemisahan |
price_coefficient |
Digunakan untuk menghitung berapa banyak kredit yang diambil pekerjaan dari pengguna premium. Menggunakan rumus ini : floor(<durasi file audio dalam detik> * price_coefficient / 60)?:1
|
usage | Shows monthly usage count of separation type |
rating | Shows monthly usage rating of separation type as array:
|
algorithm_fields | Berisi informasi tentang bidang tambahan dari jenis pemisahan |
algorithm_fields -> name |
Menunjukkan bidang tambahan jenis pemisahan:
|
algorithm_fields -> text | Menampilkan nama bidang tambahan dari jenis pemisahan. |
algorithm_fields -> options | Rantai kunci-nilai yang dikodekan JSON dari bidang tambahan |
algorithm_fields -> default_key | Nilai default dari bidang tambahan. Salah satu kunci <code>algorithm_fields -> options</code> |
algorithm_descriptions | Berisi informasi tentang deskripsi jenis pemisahan |
algorithm_descriptions -> short_description | Deskripsi kecil tentang jenis pemisahan yang tidak menggunakan HTML. |
algorithm_descriptions -> long_description | Deskripsi terperinci tentang jenis pemisahan yang menggunakan HTML. |
algorithm_descriptions -> lang | Kode bahasa yang ditentukan dalam deskripsi. |
Untuk mendapatkan informasi tentang berita terkini tentang MVSEP, Anda perlu melakukan panggilan GET ke url berikut:
https://mvsep.com/api/app/news
Bidang | Jenis | Deskripsi |
---|---|---|
lang | String | (opsional) kode bahasa 2 huruf (en, ru) |
start | Integer | (opsional) Offset titik awal, default ke 0 (yaitu mulai dari yang terbaru) |
limit | Integer | (opsional) Jumlah maksimum hasil yang dikembalikan, default ke 10, maksimum 20. |
curl --location --request GET 'https://mvsep.com/api/app/news?lang=en&start=2&limit=1'
Mengembalikan data sebagai array:
Kunci | Nilai |
---|---|
title | Judul berita |
lang | Judul berita |
text | Deskripsi berita lengkap |
created_at | Tanggal berita |
To get site queue information, you need to make a GET call to the following url:
https://mvsep.com/api/app/queue
Bidang | Jenis | Deskripsi |
---|---|---|
api_token | String | (optional) API key pengguna |
curl --location --request GET 'https://mvsep.com/api/app/queue'
Kunci | Nilai |
---|---|
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):
|
Untuk mendapatkan informasi tentang pemisahan demo, Anda perlu membuat panggilan GET ke url berikut:
https://mvsep.com/api/app/demo
Bidang | Jenis | Deskripsi |
---|---|---|
start | Integer | (opsional) Offset titik awal, default ke 0 (yaitu mulai dari yang terbaru) |
limit | Integer | (opsional) Jumlah maksimum hasil yang dikembalikan, default ke 10, maksimum 20. |
curl --location --request GET 'https://mvsep.com/api/app/demo?start=0&limit=2'
Mengembalikan data sebagai array:
Kunci | Nilai |
---|---|
hash | Hash Pemisahan |
date | Tanggal pemisahan |
input_audio | Masukkan URL audio |
size | Masukkan ukuran audio |
algorithm | Berisi informasi dasar tentang jenis pemisahan yang digunakan (lihat tab GET SEPARATION TYPES untuk informasi tentang parameter yang dikembalikan) |
Untuk mengautentikasi pengguna dan mendapatkan kunci API pengguna, Anda perlu membuat panggilan POST ke url berikut:
https://mvsep.com/api/app/login
Bidang | Jenis | Deskripsi |
---|---|---|
String | Email pengguna | |
password | String | Kata sandi pengguna |
curl --location --request POST 'https://mvsep.com/api/app/login' --form 'email="<Email pengguna>"' --form 'password="<Kata sandi pengguna>"'
Kunci | Nilai |
---|---|
success |
|
data | Berisi informasi saat kredensial valid |
data -> name | Nama pengguna |
data -> email | Email pengguna |
data -> api_token | Kunci API pengguna. Pastikan untuk menyimpannya di tempat penyimpanan yang aman dan gunakan untuk operasi selanjutnya |
data -> premium_minutes | Kredit tersisa untuk pengguna |
data -> premium_enabled |
Apakah pengguna mengizinkan kredit untuk dibelanjakan.
|
data -> long_filenames_enabled |
Apakah pengguna menginginkan informasi tambahan dalam nama file:
|
API MVSEP menggunakan kode kesalahan berikut:
Kode Kesalahan | Arti |
---|---|
400 | Kredensial yang diberikan salah |
Untuk mendaftarkan pengguna ke situs MVSEP, Anda perlu membuat panggilan POST ke url berikut:
https://mvsep.com/api/app/register
Bidang | Jenis | Deskripsi |
---|---|---|
name | String | Nama pengguna |
String | Email pengguna | |
password | String | Kata sandi pengguna |
password_confirmation | String | Ulangi kata sandi pengguna |
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"'
Kunci | Nilai |
---|---|
success |
|
message | Terjadi ketika formulir tersebut valid |
API MVSEP menggunakan kode kesalahan berikut:
Kode Kesalahan | Arti |
---|---|
400 | Formulir tidak valid |
Untuk mendapatkan informasi pengguna, Anda perlu membuat panggilan GET ke url berikut:
https://mvsep.com/api/app/user
Bidang | Jenis | Deskripsi |
---|---|---|
api_token | String | API key pengguna |
curl --location --request GET 'https://mvsep.com/api/app/user?api_token=<API Token Anda>'
Kunci | Nilai |
---|---|
success |
|
data | Berisi informasi saat kredensial valid |
data -> name | Nama pengguna |
data -> email | Email pengguna |
data -> api_token | Kunci API pengguna. Pastikan untuk menyimpannya di tempat penyimpanan yang aman dan gunakan untuk operasi selanjutnya |
data -> premium_minutes | Kredit tersisa untuk pengguna |
data -> premium_enabled |
Apakah pengguna mengizinkan kredit untuk dibelanjakan.
|
data -> long_filenames_enabled |
Apakah pengguna menginginkan informasi tambahan dalam nama file:
|
data -> current_queue | Menunjukkan pemisahan yang sedang berlangsung untuk pengguna |
API MVSEP menggunakan kode kesalahan berikut:
Kode Kesalahan | Arti |
---|---|
400 | API key tidak valid |
Untuk mendapatkan informasi dasar tentang riwayat pemisahan pengguna, Anda perlu melakukan panggilan GET ke url berikut:
https://mvsep.com/api/app/separation_history
Bidang | Jenis | Deskripsi |
---|---|---|
api_token | String | API key pengguna |
start | Integer | (opsional) Offset titik awal, default ke 0 (yaitu mulai dari yang terbaru) |
limit | Integer | (opsional) Jumlah maksimum hasil yang dikembalikan, default ke 10, maksimum 20. |
curl --location --request GET 'https://mvsep.com/api/app/separation_history?api_token=<API Token Anda>&start=1&limit=2'
Kunci | Nilai |
---|---|
success |
|
data | Berisi informasi dasar tentang pemisahan sebelumnya |
data -> hash | Hash Pemisahan |
data -> job_exists | Berisi informasi dasar tentang pemisahan sebelumnya |
data -> credits | Berapa banyak kredit yang digunakan untuk pekerjaan itu, null jika pemisahan tidak ada |
data -> time_left | Perkiraan waktu tersisa hingga pekerjaan dihapus |
data -> algorithm | Berisi informasi dasar tentang jenis pemisahan yang digunakan (lihat tab GET SEPARATION TYPES untuk informasi tentang parameter yang dikembalikan) |
API MVSEP menggunakan kode kesalahan berikut:
Kode Kesalahan | Arti |
---|---|
400 | API key tidak valid |
Untuk mengaktifkan penggunaan premium bagi pengguna, Anda perlu membuat panggilan POST ke url berikut:
https://mvsep.com/api/app/enable_premium
Bidang | Jenis | Deskripsi |
---|---|---|
api_token | String | API key pengguna |
curl --location --request POST 'https://mvsep.com/api/app/enable_premium' --form 'api_token="<API Token Anda>"'
Kunci | Nilai |
---|---|
success |
|
message | Menginformasikan tentang status operasi |
API MVSEP menggunakan kode kesalahan berikut:
Kode Kesalahan | Arti |
---|---|
400 | API key tidak valid |
Untuk menonaktifkan penggunaan premium bagi pengguna, Anda perlu membuat panggilan POST ke url berikut:
https://mvsep.com/api/app/disable_premium
Bidang | Jenis | Deskripsi |
---|---|---|
api_token | String | API key pengguna |
curl --location --request POST 'https://mvsep.com/api/app/disable_premium' --form 'api_token="<API Token Anda>"'
Kunci | Nilai |
---|---|
success |
|
message | Menginformasikan tentang status operasi |
API MVSEP menggunakan kode kesalahan berikut:
Kode Kesalahan | Arti |
---|---|
400 | API key tidak valid |
Untuk mengaktifkan nama file yang panjang bagi pengguna, Anda perlu membuat panggilan POST ke url berikut:
https://mvsep.com/api/app/enable_long_filenames
Bidang | Jenis | Deskripsi |
---|---|---|
api_token | String | API key pengguna |
curl --location --request POST 'https://mvsep.com/api/app/enable_long_filenames' --form 'api_token="<API Token Anda>"'
Kunci | Nilai |
---|---|
success |
|
message | Menginformasikan tentang status operasi |
API MVSEP menggunakan kode kesalahan berikut:
Kode Kesalahan | Arti |
---|---|
400 | API key tidak valid |
Untuk menonaktifkan nama file yang panjang bagi pengguna, Anda perlu membuat panggilan POST ke url berikut:
https://mvsep.com/api/app/disable_long_filenames
Bidang | Jenis | Deskripsi |
---|---|---|
api_token | String | API key pengguna |
curl --location --request POST 'https://mvsep.com/api/app/disable_long_filenames' --form 'api_token="<API Token Anda>"'
Kunci | Nilai |
---|---|
success |
|
message | Menginformasikan tentang status operasi |
API MVSEP menggunakan kode kesalahan berikut:
Kode Kesalahan | Arti |
---|---|
400 | API key tidak valid |
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
Bidang | Jenis | Deskripsi |
---|---|---|
start | Integer | (opsional) Offset titik awal, default ke 0 (yaitu mulai dari yang terbaru) |
limit | Integer | (opsional) Jumlah maksimum hasil yang dikembalikan, default ke 10, maksimum 20. |
curl --location --request GET 'https://mvsep.com/api/quality_checker/queue?&start=1&limit=2'
Mengembalikan data sebagai array:
Kunci | Nilai |
---|---|
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
Bidang | Jenis | Deskripsi |
---|---|---|
dataset_type | String | Dataset Type, defaults to 0 if not given
|
start | Integer | (opsional) Offset titik awal, default ke 0 (yaitu mulai dari yang terbaru) |
limit | Integer | (opsional) Jumlah maksimum hasil yang dikembalikan, default ke 10, maksimum 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'
Kunci | Nilai |
---|---|
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
Bidang | Jenis | Deskripsi |
---|---|---|
api_token | String | (required) Kunci API Anda |
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"'
Kunci | Nilai |
---|---|
success |
|
data | Contains information about entry |
data -> id | ID of the entry. |
data -> link | Link to the entry. |
API MVSEP menggunakan kode kesalahan berikut:
Kode Kesalahan | Arti |
---|---|
400 | Formulir tidak valid |
401 |
api_token tidak dikenal atau tidak valid. Kesalahan ini muncul jika Anda menggunakan kunci API yang tidak dikenal.
|
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
Bidang | Jenis | Deskripsi |
---|---|---|
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
Bidang | Jenis | Deskripsi |
---|---|---|
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"'
Kunci | Nilai |
---|---|
success |
|
data->message | Shows whether entry was deleted |
turbo@mvsep.com