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
OpenAPI Specification: mvsep-openapi-spec.json
Note that Premium users can request unlimited concurrent jobs, while non-Premium users can only request 1 concurrent job.
要创建分离任务，您需要对以下网址进行 POST 调用：
https://mvsep.com/api/separation/create
| 字段 | 类型 | 说明 |
|---|---|---|
| api_token | String | 您的 API Key |
| audiofile | Binary | 要处理的音频文件. Not required if url parameter is set or model do not use file input. For matchering models use target_audiofile and reference_audiofile for input instead of audiofile. |
| url | String | Link to the audiofile. Not required if audiofile parameter is set |
| remote_type | String | (optional) Remote type of the audiofile. Defaults to direct. Not required if audiofile parameter is set. Supported types are direct (Direct Download), mega (MEGA), drive (Google Drive), dropbox (Dropbox) |
| sep_type | Integer | (可选) 分离类型，默认为11 (Demucs3 Model B (人声，鼓声，贝斯，其他)) |
| add_opt1 | String | (可选) 分离类型的第一个额外字段 |
| add_opt2 | String | (可选) 分离类型的第二个额外字段 |
| add_opt3 | String | （可选）分离类型第三个附加字段 |
| output_format | Integer | (可选) 输出格式，默认为0 (mp3 (320kbps)) |
| is_demo | Boolean | (可选) 是否将分离结果发布到示例页，默认为false |
| 名称 | 值 | Additional fields |
|---|---|---|
| Ensemble (vocals, instrum) | 26 | Key: add_opt1 Name: Output files Options:
Key: add_opt2 Name: Model Type Options:
|
| Ensemble (vocals, instrum, bass, drums, other) | 28 | Key: add_opt1 Name: Output files Options:
Key: add_opt2 Name: Model Type Options:
|
| Ensemble All-In (vocals, bass, drums, piano, guitar, lead/back vocals, other) | 30 | Key: add_opt1 Name: Output files Options:
Key: add_opt2 Name: Model Type Options:
|
| BS Roformer SW (vocals, bass, drums, guitar, piano, other) | 63 | |
| Demucs4 HT (vocals, drums, bass, other) | 20 | Key: add_opt1 Name: Model type Options:
|
| 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:
|
| 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 | |
| MVSep 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 Crowd removal (crowd, other) | 34 | 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:
|
| MVSep Choir (choir, other) | 112 | Key: add_opt2 Name: How to extract Options:
|
| MVSep SATB Choir (soprano, alto, tenor, bass) | 111 | Key: add_opt1 Name: Model type Options:
Key: add_opt2 Name: How to extract 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 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 Synth (synth, other) | 88 | Key: add_opt1 Name: How to extract 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:
|
| MVSep Piano (piano, other) | 29 | Key: add_opt1 Name: Piano model type Options:
|
| MVSep Digital Piano (digital-piano, other) | 79 | Key: add_opt2 Name: How to extract Options:
|
| MVSep Keys (keys, other) | 106 | |
| MVSep Organ (organ, other) | 58 | Key: add_opt1 Name: Organ model type Options:
|
| MVSep Harpsichord (harpsichord, other) | 91 | |
| MVSep Accordion (accordion, other) | 99 | |
| MVSep Guitar (guitar, other) | 31 | Key: add_opt1 Name: Guitar model type Options:
|
| MVSep Acoustic Guitar (acoustic-guitar, other) | 66 | Key: add_opt2 Name: How to extract Options:
|
| MVSep Electric Guitar (electric-guitar, other) | 81 | Key: add_opt2 Name: How to extract Options:
|
| MVSep Lead/Rhythm Guitar (lead-guitar, rhythm-guitar) | 101 | Key: add_opt1 Name: Model type Options:
|
| 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 | Key: add_opt1 Name: String model type Options:
Key: add_opt2 Name: How to extract Options:
|
| MVSep Violin (violin, other) | 65 | |
| MVSep Viola (viola, other) | 69 | Key: add_opt2 Name: How to extract Options:
|
| MVSep Cello (cello, other) | 70 | Key: add_opt2 Name: How to extract Options:
|
| MVSep Double Bass (double-bass, other) | 73 | Key: add_opt2 Name: How to extract Options:
|
| 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 Brass (brass, other) | 107 | Key: add_opt1 Name: How to extract Options:
|
| MVSep Woodwind (woodwind, other) | 108 | Key: add_opt1 Name: How to extract Options:
|
| MVSep Saxophone (saxophone, other) | 61 | Key: add_opt1 Name: Model type Options:
|
| MVSep Flute (flute, other) | 67 | Key: add_opt1 Name: Flute model type Options:
Key: add_opt2 Name: How to extract Options:
|
| MVSep Trumpet (trumpet, other) | 71 | Key: add_opt2 Name: How to extract Options:
|
| MVSep Trombone (trombone, other) | 75 | Key: add_opt2 Name: How to extract Options:
|
| MVSep Oboe (oboe, other) | 77 | Key: add_opt2 Name: How to extract Options:
|
| MVSep Clarinet (clarinet, other) | 78 | Key: add_opt2 Name: How to extract Options:
|
| MVSep French Horn (french-horn, other) | 82 | Key: add_opt2 Name: How to extract Options:
|
| MVSep Harmonica (harmonica, other) | 87 | Key: add_opt2 Name: How to extract Options:
|
| MVSep Tuba (tuba, other) | 92 | |
| MVSep Bassoon (bassoon, other) | 93 | |
| MVSep Bagpipes (bagpipes , other) | 116 | Key: add_opt2 Name: How to extract Options:
|
| 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 | Key: add_opt2 Name: How to extract Options:
|
| MVSep Celesta (celesta, other) | 110 | Key: add_opt2 Name: How to extract Options:
|
| MVSep Demucs4HT DNR (speech, music, effects) | 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, effects) | 56 | Key: add_opt1 Name: Model type Options:
Key: add_opt2 Name: How to extract Options:
Key: add_opt3 Name: Output files Options:
|
| MVSep Braam (braam , other) | 117 | |
| Apollo Enhancers (by JusperLee, Lew, baicai1145) | 51 | Key: add_opt1 Name: Model type Options:
Key: add_opt2 Name: Cutoff (Hz) Options:
|
| Reverb Removal (noreverb) | 22 | Key: add_opt1 Name: Model Type Options:
Key: add_opt2 Name: Preprocess Options:
|
| DeNoise by aufr33 | 47 | Key: add_opt1 Name: Model type Options:
|
| AudioSR (Super Resolution) | 59 | Key: add_opt1 Name: Cutoff (Hz) Options:
|
| FlashSR (Super Resolution) | 60 | |
| Stable Audio Open Gen | 62 | Key: add_opt1 Name: Text prompt Options: Key: add_opt2 Name: Length (in seconds) 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:
Key: add_opt2 Name: Version Options:
|
| VibeVoice (Voice Cloning) | 103 | Key: add_opt1 Name: Model type Options:
Key: add_opt2 Name: Text prompt Options: Key: add_opt3 Name: Extract vocals first Options:
|
| VibeVoice (TTS) | 104 | Key: add_opt1 Name: Model type Options:
Key: add_opt2 Name: Text prompt Options: |
| Qwen3-TTS (Custom Voice) | 118 | Key: add_opt1 Name: Text prompt Options: Key: add_opt2 Name: Speaker Options:
Key: add_opt3 Name: Language Options:
Key: add_opt4 Name: Voice description Options: |
| Qwen3-TTS (Voice Design) | 119 | Key: add_opt1 Name: Text prompt Options: Key: add_opt2 Name: Voice description Options: Key: add_opt3 Name: Language Options:
|
| Qwen3-TTS (Voice Cloning) | 120 | Key: add_opt1 Name: Text prompt Options: Key: add_opt2 Name: Reference text in audio (optional) Options: Key: add_opt3 Name: Language Options:
Key: add_opt4 Name: Extract vocals first Options:
|
| Bark (Speech Gen) | 115 | Key: add_opt1 Name: Text prompt Options: Key: add_opt2 Name: Speaker Options:
|
| MVSep MultiSpeaker (MDX23C) | 42 | Key: add_opt1 Name: Model Type Options:
|
| Aspiration (by Sucial) | 50 | Key: add_opt1 Name: Model type Options:
|
| Phantom Centre extraction (by wesleyr36) | 55 | |
| Matchering (by sergree) | 68 | |
| SOME (Singing-Oriented MIDI Extractor) | 80 | Key: add_opt1 Name: How to use Options:
|
| Transkun (piano -> midi) | 113 | Key: add_opt1 Name: How to extract Options:
|
| Basic Pitch (MIDI Extraction) | 114 | |
| Demucs3 Model (vocals, drums, bass, other) | 10 | Key: add_opt1 Name: Model type Options:
|
| MDX A/B (vocals, drums, bass, other) | 7 | Key: add_opt1 Name: Vocal 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 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 | 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:
|
| 名称 | 值 |
|---|---|
| mp3 (320 kbps) | 0 |
| wav (uncompressed, 16 bit) | 1 |
| flac (lossless, 16 bit) | 2 |
| m4a (lossy) | 3 |
| wav (uncompressed, 32 bit) | 4 |
| flac (lossless, 24 bit) | 5 |
curl --location --request POST 'https://mvsep.com/api/separation/create'
--form 'audiofile=@"/path/to/file.mp3"'
--form 'api_token="<您的 API 令牌>"'
--form 'sep_type="9"'
--form 'add_opt1="0"'
--form 'add_opt2="1"'
--form 'output_format="1"'
--form 'is_demo="1"'
| 键 | 值 |
|---|---|
| success |
|
| data | 根据 success 键保存额外信息 |
| data -> link | 显示已创建作业的 “获取结果” URL 的链接（仅在 success 为 true 时显示） |
| data -> hash | 显示已创建的任务哈希值（仅在 success 为 true 时显示） |
| data -> message | 显示错误描述（仅在success为false时显示） |
MVSEP API 使用以下错误代码：
| 错误代码 | 含义 |
|---|---|
| 400 | 有些参数未知或无效。当您没有传入每个必需的参数，或传入了无效参数时，会出现这个错误。 |
| 401 |
未知或无效的api_token。如果您使用了未知的API密钥，则会出现此错误。
|
要获取分离结果，需要对以下网址进行 GET 调用：
https://mvsep.com/api/separation/get
| 字段 | 类型 | 说明 |
|---|---|---|
| hash | String | 此分离的哈希值 |
| mirror | Integer | （可选）如果设置为 1，则使用另一个镜像，默认为 0。需要 api_token 和 1 个积分（如果设置为 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为wating或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
| 字段 | 类型 | 说明 |
|---|---|---|
| scopes | String | Whether to include models that use different form of input.
single_upload if not provided. To get all models, set scopes=single_upload,no_upload,matchering_upload
|
curl --location --request GET 'https://mvsep.com/api/app/algorithms'
以数组形式，返回数据:
| 键 | 值 |
|---|---|
| render_id | 分离类型值（ID） |
| name | 分离类型的名称 |
| algorithm_group_id | 该组属于分离类型： |
| algorithm_group | Contains information about the algorithm group that the algorithm belongs to. |
| algorithm_group -> name | Name of the algorithm group. |
| audio_widget |
The type of audio widget to use for the algorithm. This can be used to determine how to display the audio player for the algorithm on the frontend. Possible values are:
|
| orientation |
此分离类型的对象：
|
| order_id | 分离类型的顺序 |
| price_coefficient |
用于计算工作从高级用户那里消耗了多少积分。 使用此公式 : floor(<音频文件时长（秒）> * price_coefficient / 60)?:1
|
| usage | Shows monthly usage count of separation type |
| rating | Shows monthly usage rating of separation type as array:
|
| algorithm_fields | 包含有关分离类型附加字段的信息 |
| algorithm_fields -> name |
显示分离类型的附加字段：
|
| algorithm_fields -> text | 显示分离类型附加字段的名称。 |
| algorithm_fields -> options | JSON 编码的附加字段键值链 |
| algorithm_fields -> default_key | 附加字段的默认值。<code 的键之一>algorithm_fields -> options</code> |
| algorithm_descriptions | 包含有关分离类型描述的信息 |
| algorithm_descriptions -> short_description | 不使用 HTML 的小型分离类型描述 |
| algorithm_descriptions -> long_description | 详细描述使用 HTML 的分隔类型 |
| algorithm_descriptions -> lang | 指定描述的语言代码。 |
获取关于 MVSEP 最新的信息，您需要向以下 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 | 包含有关已用分离类型的简要信息（有关返回参数的信息，请参阅“获取分离类型”选项） |
您需要向以下 URL 发送 POST 请求以验证用户并获取用户的 API 密钥：
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 | 包含有关已用分离类型的简要信息（有关返回参数的信息，请参阅“获取分离类型”选项） |
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 Key |
| 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 |
