turbo@mvsep.com
MVSEP API は、分離の作成、結果の返還、サイト情報の取得、およびユーザー機能の制御を行うためのプログラムによるアクセスを提供します。
このAPIを使用するには、APIキーが必要です ログインしていない場合は、ログインしてAPIトークンを取得してください。
Examples in Python: https://github.com/ZFTurbo/MVSep-API-Examples
Unofficial application MacVSep for Mac OS: https://github.com/septcoco/macvsep
Webhooks can be setup here: Webhooks Page
プレミアムユーザーは10の同時ジョブをリクエストできるのに対し、非プレミアムユーザーは1の同時ジョブのみリクエストできますのでご注意ください
分離を作成するには、以下のURLにPOSTコールを行う必要があります
https://mvsep.com/api/separation/create
| フィールド | タイプ | 説明 |
|---|---|---|
| api_token | String | あなたのAPIキー |
| audiofile | Binary | 処理されるオーディオファイル. Not required if url parameter is set |
| url | String | Link to the audiofile. Not required if audiofile parameter is set |
| remote_type | String | (optional) Remote type of the audiofile. Defaults to direct. Not required if audiofile parameter is set. Supported types are direct (Direct Download), mega (MEGA), drive (Google Drive), dropbox (Dropbox) |
| sep_type | Integer | (オプション) Separation Type、デフォルトは11 (Demucs3 Model B (ボーカル、ドラム、ベース、その他)) |
| add_opt1 | String | (オプション) 分離タイプ 最初の追加フィールド |
| add_opt2 | String | (オプション) セパレーション・タイプ 2番目の追加フィールド |
| add_opt3 | String | (オプション) 分離タイプ 3 番目の追加フィールド |
| output_format | Integer | (オプション) 出力フォーマット、デフォルトは 0 (mp3 (320kbps)) |
| is_demo | Boolean | (オプション) 分離をデモページに公開するかどうか。 |
| 名称 | 価値 | Additional fields |
|---|---|---|
| Ensemble (vocals, instrum) | 26 | Key: add_opt1 Name: Output files Options:
Key: add_opt2 Name: Model Type Options:
|
| Ensemble (vocals, instrum, bass, drums, other) | 28 | Key: add_opt1 Name: Output files Options:
Key: add_opt2 Name: Model Type Options:
|
| Ensemble All-In (vocals, bass, drums, piano, guitar, lead/back vocals, other) | 30 | Key: add_opt1 Name: Output files Options:
Key: add_opt2 Name: Model Type Options:
|
| BS Roformer SW (vocals, bass, drums, guitar, piano, other) | 63 | |
| BS Roformer (vocals, instrumental) | 40 | Key: add_opt1 Name: Vocal model type Options:
|
| MelBand Roformer (vocals, instrumental) | 48 | Key: add_opt1 Name: Vocal model type Options:
|
| MDX23C (vocals, instrumental) | 25 | Key: add_opt1 Name: Vocal model type Options:
|
| SCNet (vocals, instrumental) | 46 | Key: add_opt1 Name: Vocal model type Options:
|
| Demucs4 HT (vocals, drums, bass, other) | 20 | Key: add_opt1 Name: Model type Options:
|
| MDX B (vocals, instrumental) | 23 | Key: add_opt1 Name: Vocal model type Options:
|
| Ultimate Vocal Remover VR (vocals, music) | 9 | Key: add_opt1 Name: Model Type Options:
Key: add_opt2 Name: Agressiveness Options:
|
| Demucs4 Vocals 2023 (vocals, instrum) | 27 | |
| MelBand Karaoke (lead/back vocals) | 49 | Key: add_opt1 Name: Karaoke model type Options:
Key: add_opt2 Name: Extraction type Options:
|
| MDX-B Karaoke (lead/back vocals) | 12 | Key: add_opt1 Name: Karaoke model type Options:
|
| MVSep Piano (piano, other) | 29 | Key: add_opt1 Name: Piano model type Options:
|
| MVSep Guitar (guitar, other) | 31 | Key: add_opt1 Name: Guitar model type Options:
|
| MVSep Bass (bass, other) | 41 | Key: add_opt1 Name: Bass model type Options:
Key: add_opt2 Name: How to extract Options:
Key: add_opt3 Name: Output files Options:
|
| MVSep Drums (drums, other) | 44 | Key: add_opt1 Name: Drums model type Options:
Key: add_opt2 Name: How to extract Options:
Key: add_opt3 Name: Output files Options:
|
| MVSep Strings (strings, other) | 52 | |
| MVSep Wind (wind, other) | 54 | Key: add_opt1 Name: Wind model type Options:
Key: add_opt2 Name: How to extract Options:
Key: add_opt3 Name: Output files Options:
|
| MVSep Organ (organ, other) | 58 | Key: add_opt1 Name: Organ model type Options:
|
| MVSep Saxophone (saxophone, other) | 61 | Key: add_opt1 Name: Model type Options:
|
| MVSep Violin (violin, other) | 65 | |
| Apollo Enhancers (by JusperLee and Lew) | 51 | Key: add_opt1 Name: Model type Options:
|
| Reverb Removal (noreverb) | 22 | Key: add_opt1 Name: Model Type Options:
Key: add_opt2 Name: Preprocess Options:
|
| MVSep Crowd removal (crowd, other) | 34 | Key: add_opt1 Name: Model type Options:
|
| MVSep Demucs4HT DNR (dialog, sfx, music) | 24 | Key: add_opt1 Name: Model type Options:
|
| BandIt Plus (speech, music, effects) | 36 | |
| BandIt v2 (speech, music, effects) | 45 | Key: add_opt1 Name: Model Type Options:
|
| MVSep DnR v3 (speech, music, sfx) | 56 | Key: add_opt1 Name: Model type Options:
Key: add_opt2 Name: How to extract Options:
Key: add_opt3 Name: Output files Options:
|
| DrumSep (4-6 stems: kick, snare, cymbals, toms, ride, hh, crash) | 37 | Key: add_opt1 Name: Model Type Options:
Key: add_opt2 Name: Preprocess Options:
|
| DeNoise by aufr33 | 47 | Key: add_opt1 Name: Model type Options:
|
| Whisper (extract text from audio) | 39 | Key: add_opt1 Name: Model type Options:
Key: add_opt2 Name: Transcription type Options:
|
| Parakeet (extract text from audio) | 64 | Key: add_opt1 Name: Model type Options:
|
| Medley Vox (Multi-singer separation) | 53 | Key: add_opt1 Name: Model type Options:
|
| MVSep Multichannel BS (vocals, instrumental) | 43 | Key: add_opt1 Name: Model Type Options:
|
| MVSep Male/Female separation | 57 | Key: add_opt1 Name: Model type Options:
Key: add_opt2 Name: How to extract Options:
|
| MDX A/B (vocals, drums, bass, other) | 7 | Key: add_opt1 Name: Vocal model type Options:
|
| Demucs3 Model (vocals, drums, bass, other) | 10 | Key: add_opt1 Name: Model type Options:
|
| Vit Large 23 (vocals, instrum) | 33 | Key: add_opt1 Name: Model type Options:
|
| UVRv5 Demucs (vocals, music) | 17 | Key: add_opt1 Name: Model Type Options:
|
| MVSep DNR (music, sfx, speech) | 18 | |
| MVSep Vocal Model (vocals, music) | 19 | |
| Demucs2 (vocals, drums, bass, other) | 13 | |
| Danna Sep (vocals, drums, bass, other) | 15 | |
| Byte Dance (vocals, drums, bass, other) | 16 | |
| MVSep MelBand Roformer (vocals, instrum) | 35 | |
| spleeter | 0 | Key: add_opt1 Name: Model type Options:
|
| UnMix | 3 | Key: add_opt1 Name: Model type Options:
|
| Zero Shot (Query Based) (Low quality) | 14 | Key: add_opt1 Name: Model Type Options:
|
| LarsNet (kick, snare, cymbals, toms, hihat) | 38 | Key: add_opt1 Name: Model type Options:
|
| Stable Audio Open Gen | 62 | Key: add_opt1 Name: Text prompt Options: Key: add_opt2 Name: Length (in seconds) Options:
|
| MVSep MultiSpeaker (MDX23C) | 42 | Key: add_opt1 Name: Model Type Options:
|
| Aspiration (by Sucial) | 50 | Key: add_opt1 Name: Model type Options:
|
| AudioSR (Super Resolution) | 59 | Key: add_opt1 Name: Cutoff (Hz) Options:
|
| Phantom Centre extraction (by wesleyr36) | 55 | |
| FlashSR (Super Resolution) | 60 |
| 名称 | 価値 |
|---|---|
| mp3 (320 kbps) | 0 |
| wav (uncompressed, 16 bit) | 1 |
| flac (lossless, 16 bit) | 2 |
| m4a (lossy) | 3 |
| wav (uncompressed, 32 bit) | 4 |
| flac (lossless, 24 bit) | 5 |
curl --location --request POST 'https://mvsep.com/api/separation/create'
--form 'audiofile=@"/path/to/file.mp3"'
--form 'api_token="<あなたのAPIトークン>"'
--form 'sep_type="9"'
--form 'add_opt1="0"'
--form 'add_opt2="1"'
--form 'output_format="1"'
--form 'is_demo="1"'
| キー | 価値 |
|---|---|
| success |
|
| data | successキーに応じて追加情報を保持します |
| data -> link | 作成したジョブの「GET RESULT」URLへのリンクを表示します(successがtrueの場合のみ表示されます) |
| data -> hash | 作成されたジョブハッシュを表示します(successがtrueの場合にのみ表示されます)。 |
| data -> message | エラーの説明を表示します (success が false の場合にのみ表示されます)。 |
MVSEP API は以下のエラーコードを使用します：
| エラーコード | 意味 |
|---|---|
| 400 | 一部のパラメータが不足しているか、無効です。このエラーは、必須パラメータをすべて渡していないか、無効なパラメータを渡した場合に表示されます。 |
| 401 |
不明または無効な api_token. このエラーは、不明なAPIキーを使用した場合に表示されます。
|
分離結果を得るには、以下のURLにGETコールをする必要がある：
https://mvsep.com/api/separation/get
| フィールド | タイプ | 説明 |
|---|---|---|
| hash | String | 分離のハッシュ |
| mirror | Integer | (オプション) 1 に設定されている場合は別のミラーを使用し、デフォルトは 0 です。1に設定されている場合は、api_tokenと1クレジットが必要です。 |
| api_token | string | (省略可能) ユーザーの API キー。mirror パラメータが 1 に設定されている場合は必須です。 |
curl --location --request GET 'https://mvsep.com/api/separation/get?hash=20230327071601-0e3e5c6c85-13-dimensions.mp3'
| キー | 価値 |
|---|---|
| success |
|
| status |
|
| data | statusキーに応じて追加情報を保持します |
| data -> queue_count | 未処理のジョブ数をユーザーの優先度で表示します (status が waiting または distributing の場合にのみ表示されます) |
| data -> current_order | ユーザーのジョブの順序を表示します (status が waiting または distributing の場合にのみ表示されます) |
| data -> message | ステータスの説明を表示します (すべてのステータスに表示され、status が failed の場合はエラーの理由を表示します)。 |
| data -> algorithm | ジョブで使用されているアルゴリズムを表示します (status が done の場合にのみ表示されます)。 |
| data -> algorithm_description | ジョブで使用されたアルゴリズムの詳細を表示します (status が done の場合にのみ表示されます)。 |
| data -> output_format | ジョブの出力形式を表示します (status が done の場合にのみ表示されます)。 |
| data -> tags | オーディオメタタグを表示します(statusがdoneの場合にのみ表示されます) |
| data -> input_file | 入力オーディオのダウンロードの詳細を表示します (status が done の場合にのみ表示されます)。 |
| data -> files | 出力オーディオのダウンロード詳細を表示します(statusがdoneの場合にのみ表示されます) |
| data -> date | ジョブの処理日を表示します (status が done の場合にのみ表示されます)。 |
| data -> finished_chunks | 大きなジョブの完了パーツの数を表示します (status が distributing の場合にのみ表示されます)。 |
| data -> all_chunks | 大きなジョブのすべてのパーツの数を表示します (status が distributing の場合にのみ表示されます) |
To get the result of remote job, you need to make a GET call to the following url:
https://mvsep.com/api/separation/get-remote
| フィールド | タイプ | 説明 |
|---|---|---|
| hash | String | 分離のハッシュ |
curl --location --request GET 'https://mvsep.com/api/separation/get-remote?hash=n2AwBjy4KsFZfqqR'
| キー | 価値 |
|---|---|
| success |
|
| status |
|
| data | statusキーに応じて追加情報を保持します |
| data -> queue_count | Shows unprocessed jobs count in user's priority (only shown when status is waiting) |
| data -> current_order | Shows the order of user's job (only shown when status is waiting) |
| data -> message | Shows the description of status (only when status is failed) |
| data -> link | Shows link to "GET RESULT" URL of created job (only shown when status is done) |
| data -> hash | Hash of the separation (only shown when status is done) |
To cancel the separation and refund used credits (if the separation is not being processed yet), you need to make a POST call to the following url:
https://mvsep.com/api/separation/cancel
| フィールド | タイプ | 説明 |
|---|---|---|
| api_token | string | ユーザーのAPIキー |
| hash | string | 分離のハッシュ |
curl --location --request POST 'https://mvsep.com/api/separation/cancel' --form 'api_token="<あなたのAPIトークン>"' --form 'hash="<hash>"'
| キー | 価値 |
|---|---|
| success |
|
分離タイプに関する詳細なデータを取得するには、次のURLに対してGET呼び出しを行う必要があります。
https://mvsep.com/api/app/algorithms
curl --location --request GET 'https://mvsep.com/api/app/algorithms'
データを配列として返します:
| キー | 価値 |
|---|---|
| render_id | 分離タイプの値 (ID) |
| name | 分離タイプの名前 |
| algorithm_group_id |
分離タイプが属するグループ:
|
| orientation |
この分離タイプは誰を対象としていますか?
|
| order_id | 分離タイプの順序 |
| price_coefficient |
プレミアムユーザーからジョブが取得するクレジット数を計算するために使用されます。 次の式を使用します : floor(<オーディオファイルの長さ (秒)> * price_coefficient / 60)?:1
|
| usage | Shows monthly usage count of separation type |
| rating | Shows monthly usage rating of separation type as array:
|
| algorithm_fields | 分離タイプの追加フィールドに関する情報が含まれます |
| algorithm_fields -> name |
分離タイプのどの追加フィールドが表示されます。
|
| algorithm_fields -> text | 分離タイプの追加フィールドの表示名。 |
| algorithm_fields -> options | JSONエンコードされた追加フィールドのキーと値のチェーン |
| algorithm_fields -> default_key | 追加フィールドのデフォルト値。<code>algorithm_fields -> options</code>のキーの 1 つです> |
| algorithm_descriptions | 分離タイプの説明に関する情報が含まれています |
| algorithm_descriptions -> short_description | HTMLを使用しない分離タイプの簡単な説明。 |
| algorithm_descriptions -> long_description | HTML を使用する分離の種類について詳しく説明します。 |
| algorithm_descriptions -> lang | 説明の指定された言語コード。 |
MVSEP に関する最新ニュースに関する情報を取得するには、次の URL に対して GET 呼び出しを行う必要があります。
https://mvsep.com/api/app/news
| フィールド | タイプ | 説明 |
|---|---|---|
| lang | String | (省略可能) 2 文字の言語コード (EN、RU) |
| start | Integer | (オプション)開始点オフセット、デフォルトは0(つまり、最新から開始) |
| limit | Integer | (オプション) 返される結果の最大量 (既定値は 10、最大値は 20)。 |
curl --location --request GET 'https://mvsep.com/api/app/news?lang=en&start=2&limit=1'
データを配列として返します:
| キー | 価値 |
|---|---|
| title | ニュースのタイトル |
| lang | ニュースのタイトル |
| text | ニュースの完全な説明 |
| created_at | ニュースの日付 |
To get site queue information, you need to make a GET call to the following url:
https://mvsep.com/api/app/queue
| フィールド | タイプ | 説明 |
|---|---|---|
| api_token | String | (optional) ユーザーのAPIキー |
curl --location --request GET 'https://mvsep.com/api/app/queue'
| キー | 価値 |
|---|---|
| queue |
Contains array of current queues for different plans:
|
| plan |
Contains current queue for current plan (add api_token to request for registered/premium plan):
|
デモの分離に関する情報を取得するには、次の URL に対して GET 呼び出しを行う必要があります。
https://mvsep.com/api/app/demo
| フィールド | タイプ | 説明 |
|---|---|---|
| start | Integer | (オプション)開始点オフセット、デフォルトは0(つまり、最新から開始) |
| limit | Integer | (オプション) 返される結果の最大量 (既定値は 10、最大値は 20)。 |
curl --location --request GET 'https://mvsep.com/api/app/demo?start=0&limit=2'
データを配列として返します:
| キー | 価値 |
|---|---|
| hash | 分離のハッシュ |
| date | 別居の日付 |
| input_audio | オーディオURLの入力 |
| size | 入力オーディオサイズ |
| algorithm | 使用される分離タイプに関する基本情報が含まれます (返されるパラメーターについては、GET SEPARATION TYPES タブを参照してください)。 |
ユーザーを認証し、ユーザーのAPIキーを取得するには、次のURLに対してPOST呼び出しを行う必要があります。
https://mvsep.com/api/app/login
| フィールド | タイプ | 説明 |
|---|---|---|
| String | ユーザーのメール | |
| password | String | ユーザーのパスワード |
curl --location --request POST 'https://mvsep.com/api/app/login' --form 'email="<ユーザーのメール>"' --form 'password="<ユーザーのパスワード>"'
| キー | 価値 |
|---|---|
| success |
|
| data | 資格情報が有効な場合の情報が含まれます |
| data -> name | ユーザーの名前 |
| data -> email | ユーザーのメール |
| data -> api_token | ユーザーの API キー。必ず安全なストレージに保管し、その後の操作に使用してください。 |
| data -> premium_minutes | ユーザーに残されたクレジット |
| data -> premium_enabled |
ユーザーがクレジットの使用を許可したかどうか。
|
| data -> long_filenames_enabled |
ユーザーがファイル名に追加の情報を求めているかどうか:
|
MVSEP API は以下のエラーコードを使用します：
| エラーコード | 意味 |
|---|---|
| 400 | 正しくない資格情報が指定されました |
MVSEP サイトにユーザーを登録するには、次の URL に対して POST 呼び出しを行う必要があります。
https://mvsep.com/api/app/register
| フィールド | タイプ | 説明 |
|---|---|---|
| name | String | ユーザーの名前 |
| String | ユーザーのメール | |
| password | String | ユーザーのパスワード |
| password_confirmation | String | ユーザーのパスワードを再入力してください |
curl --location --request GET 'https://mvsep.com/api/app/register' --form 'name="user"'
--form 'email="asdf@example.com"'
--form 'password="ASDFQWEr123"'
--form 'password_confirmation="ASDFQWEr123"'
| キー | 価値 |
|---|---|
| success |
|
| message | フォームが有効な場合に発生します |
MVSEP API は以下のエラーコードを使用します：
| エラーコード | 意味 |
|---|---|
| 400 | フォームが無効です |
ユーザー情報を取得するには、次の URL に対して GET 呼び出しを行う必要があります。
https://mvsep.com/api/app/user
| フィールド | タイプ | 説明 |
|---|---|---|
| api_token | String | ユーザーのAPIキー |
curl --location --request GET 'https://mvsep.com/api/app/user?api_token=<あなたのAPIトークン>'
| キー | 価値 |
|---|---|
| success |
|
| data | 資格情報が有効な場合の情報が含まれます |
| data -> name | ユーザーの名前 |
| data -> email | ユーザーのメール |
| data -> api_token | ユーザーの API キー。必ず安全なストレージに保管し、その後の操作に使用してください。 |
| data -> premium_minutes | ユーザーに残されたクレジット |
| data -> premium_enabled |
ユーザーがクレジットの使用を許可したかどうか。
|
| data -> long_filenames_enabled |
ユーザーがファイル名に追加の情報を求めているかどうか:
|
| data -> current_queue | ユーザーの進行中の分離を表示します |
MVSEP API は以下のエラーコードを使用します：
| エラーコード | 意味 |
|---|---|
| 400 | 無効な API キー |
ユーザーの基本的な情報の分離履歴を取得するには、次の URL に対して GET 呼び出しを行う必要があります。
https://mvsep.com/api/app/separation_history
| フィールド | タイプ | 説明 |
|---|---|---|
| api_token | String | ユーザーのAPIキー |
| start | Integer | (オプション)開始点オフセット、デフォルトは0(つまり、最新から開始) |
| limit | Integer | (オプション) 返される結果の最大量 (既定値は 10、最大値は 20)。 |
curl --location --request GET 'https://mvsep.com/api/app/separation_history?api_token=<あなたのAPIトークン>&start=1&limit=2'
| キー | 価値 |
|---|---|
| success |
|
| data | 以前の分離に関する基本情報配列が含まれています |
| data -> hash | 分離のハッシュ |
| data -> job_exists | 以前の分離に関する基本情報配列が含まれています |
| data -> credits | ジョブに使用されたクレジット数 (分離が存在しない場合は NULL) |
| data -> time_left | ジョブが削除されるまでのおおよその残り時間 |
| data -> algorithm | 使用される分離タイプに関する基本情報が含まれます (返されるパラメーターについては、GET SEPARATION TYPES タブを参照してください)。 |
MVSEP API は以下のエラーコードを使用します：
| エラーコード | 意味 |
|---|---|
| 400 | 無効な API キー |
ユーザーのプレミアム使用を有効にするには、次のURLに対してPOST呼び出しを行う必要があります。
https://mvsep.com/api/app/enable_premium
| フィールド | タイプ | 説明 |
|---|---|---|
| api_token | String | ユーザーのAPIキー |
curl --location --request POST 'https://mvsep.com/api/app/enable_premium' --form 'api_token="<あなたのAPIトークン>"'
| キー | 価値 |
|---|---|
| success |
|
| message | 操作のステータスを通知します |
MVSEP API は以下のエラーコードを使用します：
| エラーコード | 意味 |
|---|---|
| 400 | 無効な API キー |
ユーザーのプレミアム使用を無効にするには、次のURLに対してPOST呼び出しを行う必要があります。
https://mvsep.com/api/app/disable_premium
| フィールド | タイプ | 説明 |
|---|---|---|
| api_token | String | ユーザーのAPIキー |
curl --location --request POST 'https://mvsep.com/api/app/disable_premium' --form 'api_token="<あなたのAPIトークン>"'
| キー | 価値 |
|---|---|
| success |
|
| message | 操作のステータスを通知します |
MVSEP API は以下のエラーコードを使用します：
| エラーコード | 意味 |
|---|---|
| 400 | 無効な API キー |
ユーザーの長いファイル名を有効にするには、次のURLに対してPOST呼び出しを行う必要があります。
https://mvsep.com/api/app/enable_long_filenames
| フィールド | タイプ | 説明 |
|---|---|---|
| api_token | String | ユーザーのAPIキー |
curl --location --request POST 'https://mvsep.com/api/app/enable_long_filenames' --form 'api_token="<あなたのAPIトークン>"'
| キー | 価値 |
|---|---|
| success |
|
| message | 操作のステータスを通知します |
MVSEP API は以下のエラーコードを使用します：
| エラーコード | 意味 |
|---|---|
| 400 | 無効な API キー |
ユーザーの長いファイル名を無効にするには、次の URL に対して POST 呼び出しを行う必要があります。
https://mvsep.com/api/app/disable_long_filenames
| フィールド | タイプ | 説明 |
|---|---|---|
| api_token | String | ユーザーのAPIキー |
curl --location --request POST 'https://mvsep.com/api/app/disable_long_filenames' --form 'api_token="<あなたのAPIトークン>"'
| キー | 価値 |
|---|---|
| success |
|
| message | 操作のステータスを通知します |
MVSEP API は以下のエラーコードを使用します：
| エラーコード | 意味 |
|---|---|
| 400 | 無効な API キー |
To get information about Quality Checker queue entries, you need to make a GET call to the following url:
https://mvsep.com/api/quality_checker/queue
| フィールド | タイプ | 説明 |
|---|---|---|
| start | Integer | (オプション)開始点オフセット、デフォルトは0(つまり、最新から開始) |
| limit | Integer | (オプション) 返される結果の最大量 (既定値は 10、最大値は 20)。 |
curl --location --request GET 'https://mvsep.com/api/quality_checker/queue?&start=1&limit=2'
データを配列として返します:
| キー | 価値 |
|---|---|
| id | Identification number of entry |
| dataset_type | Dataset Type chosen when adding the entry / Leaderboard type
|
| date | Created date of the entry |
| algo_name | Name of the used separation type/algorithm |
| main_text | Description of the used separation type/algorithm |
| proc | Status of the processing
|
| proc_remote_date | Timestamp of processing date |
| msg | Returns "OK" if successful, otherwise shows error message |
| metrics | Information about entry metrics |
| sdr_* (wildcard) | SDR of the corresponding stems |
| dataset_name | Name of the dataset |
To get information about Quality Checker leaderboards, you need to make a GET call to the following url:
https://mvsep.com/api/quality_checker/leaderboard
| フィールド | タイプ | 説明 |
|---|---|---|
| dataset_type | String | Dataset Type, defaults to 0 if not given
|
| start | Integer | (オプション)開始点オフセット、デフォルトは0(つまり、最新から開始) |
| limit | Integer | (オプション) 返される結果の最大量 (既定値は 10、最大値は 20)。 |
| algo_name_filter | String | Filters Separation Type/Algorithm names by given text |
| sort | String | Sort by given SDR of the stem. You can get list of sortable values for given dataset type from sortables key in response |
curl --location --request GET 'https://mvsep.com/api/quality_checker/leaderboard?&start=1&limit=2&algo_name_filter=MVSep'
| キー | 価値 |
|---|---|
| data | Contains array of Quality Checker entries. Refer to GET QUEUE response from Quality Checker Section for more information |
| dataset_type | Used dataset type key |
| sortables | Keys that can be used to sort used dataset type by given stem in sequential order. |
| sort | Used sorting key from sortable. |
To create Quality Checker entry, you need to make a POST call to the following url:
https://mvsep.com/api/quality_checker/add
| フィールド | タイプ | 説明 |
|---|---|---|
| api_token | String | (required) あなたのAPIキー |
| zipfile | Binary | (required) Zip file to be processed |
| algo_name | String | (required) Name of the algorithm |
| main_text | String | (required) Description of the algorithm |
| dataset_type | String | Dataset type. Defaults to 0.
|
| password | String | (required) Password to delete algorithm |
| ensemble | integer | 0 - algorithm is not ensemble. 1 - algorithm is ensemble. |
curl --location 'https://mvsep.com/api/quality_checker/add' --form 'zipfile=@"/path/to/zipfile"' --form 'algo_name="Test Algorithm Name"' --form 'main_text="Test Algorithm Description"' --form 'dataset_type="2"' --form 'ensemble="1"' --form 'password="test"'
| キー | 価値 |
|---|---|
| success |
|
| data | Contains information about entry |
| data -> id | ID of the entry. |
| data -> link | Link to the entry. |
MVSEP API は以下のエラーコードを使用します：
| エラーコード | 意味 |
|---|---|
| 400 | フォームが無効です |
| 401 |
不明または無効な api_token. このエラーは、不明なAPIキーを使用した場合に表示されます。
|
To get information about Quality Checker queue entry by id, you need to make a GET call to the following url:
https://mvsep.com/api/quality_checker/entry
| フィールド | タイプ | 説明 |
|---|---|---|
| id | Integer | (required) ID of the entry |
curl --location --request GET 'https://mvsep.com/api/quality_checker/entry?id=7675'
To delete Quality Checker queue entry by id and password, you need to make a GET call to the following url:
https://mvsep.com/api/quality_checker/delete
| フィールド | タイプ | 説明 |
|---|---|---|
| id | Integer | (required) ID of the entry |
| password | String | (required) Used password for the entry |
curl --location 'https://mvsep.com/api/quality_checker/delete' --form 'id="7720"' --form 'password="test"'
| キー | 価値 |
|---|---|
| success |
|
| data->message | Shows whether entry was deleted |
turbo@mvsep.com