turbo@mvsep.com
MVSEP API 提供编程访问，用于创建分离、返回结果、获取站点信息和控制用户功能。
要使用此 API，您需要一个 API 密钥。 您尚未登录，请登录以获取您的 API 令牌。
Python 示例: https://github.com/ZFTurbo/MVSep-API-Examples
适用于 Mac OS 的非官方应用 MacVSep: https://github.com/septcoco/macvsep
可在此处设置 Webhooks: Webhooks 页面
OpenAPI 规范: mvsep-openapi-spec.json
请注意，Premium 用户可以申请无限并发任务，而非 Premium 用户仅能申请 1 个并发任务。
MVSEP runs regional API endpoints. All regions share one account database, so the same account, API key and job hashes work everywhere:
https://de.mvsep.com/apihttps://hk.mvsep.com/apiRequests to https://mvsep.com/api are geo-steered to the region nearest to the caller. For API integrations we recommend calling a regional endpoint explicitly — it keeps the whole job lifecycle on one host regardless of where your requests originate from.
Every separation is processed and stored in the region where it was created, and the download URLs returned in responses always point to that region's host. For best performance, choose the endpoint closest to your servers and use the same host for the whole job lifecycle — create, status polling and file downloads.
You can query the status of any job from any region (the database is shared), but the output files themselves are always served by the region that owns the job.
要创建分离任务，您需要对以下网址进行 POST 调用：
https://mvsep.com/api/separation/create
| 字段 | 类型 | 说明 |
|---|---|---|
| api_token | 字符串 | 您的 API Key |
| audiofile | 二进制 | 待处理的音频文件。如果设置了 url 参数或模型不需要文件输入，则此项非必填。对于音频匹配（matchering）模型，请使用 target_audiofile 和 reference_audiofile 作为输入，而非 audiofile。 |
| url | 字符串 | 音频文件链接。如果已设置 audiofile 参数，则此项非必填。 |
| remote_type | 字符串 | （可选）音频文件的远程类型。默认为 direct。如果已设置 audiofile 参数，则此项非必填。支持的类型包括 direct（直接下载）、mega（MEGA）、drive（Google 云端硬盘）、dropbox（Dropbox）。 |
| sep_type | 整数 | (可选) 分离类型，默认为11 (Demucs3 Model B (人声，鼓声，贝斯，其他)) |
| add_opt1 | 字符串 | (可选) 分离类型的第一个额外字段 |
| add_opt2 | 字符串 | (可选) 分离类型的第二个额外字段 |
| add_opt3 | 字符串 | （可选）分离类型第三个附加字段 |
| output_format | 整数 | (可选) 输出格式，默认为0 (mp3 (320kbps)) |
| is_demo | 布尔值 | (可选) 是否将分离结果发布到示例页，默认为false |
| 名称 | 值 | 附加字段 |
|---|---|---|
| Ensemble (vocals, instrum) | 26 | 键: add_opt1 名称: Output files 选项:
键: add_opt2 名称: Model Type 选项:
|
| Ensemble (vocals, instrum, bass, drums, other) | 28 | 键: add_opt1 名称: Output files 选项:
键: add_opt2 名称: Model Type 选项:
|
| Ensemble All-In (vocals, bass, drums, piano, guitar, lead/back vocals, other) | 30 | 键: add_opt1 名称: Output files 选项:
键: add_opt2 名称: Model Type 选项:
|
| BS Roformer SW (vocals, bass, drums, guitar, piano, other) | 63 | |
| Demucs4 HT (vocals, drums, bass, other) | 20 | 键: add_opt1 名称: Model type 选项:
|
| BS Roformer (vocals, instrumental) | 40 | 键: add_opt1 名称: Vocal model type 选项:
键: add_opt2 名称: Overlap 选项:
|
| BS PolarFormer (vocals, instrumental) | 123 | 键: add_opt1 名称: Model type 选项:
键: add_opt2 名称: Overlap 选项:
|
| MelBand Roformer (vocals, instrumental) | 48 | 键: add_opt1 名称: Vocal model type 选项:
键: add_opt2 名称: Overlap 选项:
|
| MDX23C (vocals, instrumental) | 25 | 键: add_opt1 名称: Vocal model type 选项:
|
| SCNet (vocals, instrumental) | 46 | 键: add_opt1 名称: Vocal model type 选项:
|
| MDX B (vocals, instrumental) | 23 | 键: add_opt1 名称: Vocal model type 选项:
|
| Ultimate Vocal Remover VR (vocals, music) | 9 | 键: add_opt1 名称: Model Type 选项:
键: add_opt2 名称: Agressiveness 选项:
|
| Demucs4 Vocals 2023 (vocals, instrum) | 27 | |
| MVSep Karaoke (lead/back vocals) | 49 | 键: add_opt1 名称: Karaoke model type 选项:
键: add_opt2 名称: Extraction type 选项:
|
| MDX-B Karaoke (lead/back vocals) | 12 | 键: add_opt1 名称: Karaoke model type 选项:
|
| MVSep Crowd removal (crowd, other) | 34 | 键: add_opt1 名称: Model type 选项:
|
| Medley Vox (Multi-singer separation) | 53 | 键: add_opt1 名称: Model type 选项:
|
| MVSep Multichannel BS (vocals, instrumental) | 43 | 键: add_opt1 名称: Model Type 选项:
键: add_opt2 名称: Processing Mode 选项:
|
| MVSep Male/Female separation | 57 | 键: add_opt1 名称: Model type 选项:
键: add_opt2 名称: How to extract 选项:
|
| MVSep Choir (choir, other) | 112 | 键: add_opt2 名称: How to extract 选项:
|
| MVSep SATB Choir (soprano, alto, tenor, bass) | 111 | 键: add_opt1 名称: Model type 选项:
键: add_opt2 名称: How to extract 选项:
|
| MVSep Drums (drums, other) | 44 | 键: add_opt1 名称: Drums model type 选项:
键: add_opt2 名称: How to extract 选项:
键: add_opt3 名称: Output files 选项:
|
| MVSep Bass (bass, other) | 41 | 键: add_opt1 名称: Bass model type 选项:
键: add_opt2 名称: How to extract 选项:
键: add_opt3 名称: Output files 选项:
|
| MVSep Synth (synth, other) | 88 | 键: add_opt1 名称: How to extract 选项:
|
| DrumSep (4-6 stems: kick, snare, cymbals, toms, ride, hh, crash) | 37 | 键: add_opt1 名称: Model Type 选项:
键: add_opt2 名称: Preprocess 选项:
|
| MVSep Piano (piano, other) | 29 | 键: add_opt1 名称: Piano model type 选项:
|
| MVSep Digital Piano (digital-piano, other) | 79 | 键: add_opt2 名称: How to extract 选项:
|
| MVSep Keys (keys, other) | 106 | |
| MVSep Organ (organ, other) | 58 | 键: add_opt1 名称: Organ model type 选项:
|
| MVSep Harpsichord (harpsichord, other) | 91 | |
| MVSep Accordion (accordion, other) | 99 | |
| MVSep Vibraphone | 129 | |
| MVSep Metal Bars | 130 | |
| MVSep Rhodes | 131 | |
| MVSep Guitar (guitar, other) | 31 | 键: add_opt1 名称: Guitar model type 选项:
|
| MVSep Acoustic Guitar (acoustic-guitar, other) | 66 | 键: add_opt2 名称: How to extract 选项:
|
| MVSep Electric Guitar (electric-guitar, other) | 81 | 键: add_opt2 名称: How to extract 选项:
|
| MVSep Lead/Rhythm Guitar (lead-guitar, rhythm-guitar) | 101 | 键: add_opt1 名称: Model type 选项:
|
| 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 | 键: add_opt1 名称: String model type 选项:
键: add_opt2 名称: How to extract 选项:
|
| MVSep Violin (violin, other) | 65 | |
| MVSep Viola (viola, other) | 69 | 键: add_opt2 名称: How to extract 选项:
|
| MVSep Cello (cello, other) | 70 | 键: add_opt2 名称: How to extract 选项:
|
| MVSep Double Bass (double-bass, other) | 73 | 键: add_opt2 名称: How to extract 选项:
|
| MVSep Wind (wind, other) | 54 | 键: add_opt1 名称: Wind model type 选项:
键: add_opt2 名称: How to extract 选项:
键: add_opt3 名称: Output files 选项:
|
| MVSep Brass (brass, other) | 107 | 键: add_opt1 名称: How to extract 选项:
|
| MVSep Woodwind (woodwind, other) | 108 | 键: add_opt1 名称: How to extract 选项:
|
| MVSep Saxophone (saxophone, other) | 61 | 键: add_opt1 名称: Model type 选项:
|
| MVSep Flute (flute, other) | 67 | 键: add_opt1 名称: Flute model type 选项:
键: add_opt2 名称: How to extract 选项:
|
| MVSep Trumpet (trumpet, other) | 71 | 键: add_opt2 名称: How to extract 选项:
|
| MVSep Trombone (trombone, other) | 75 | 键: add_opt2 名称: How to extract 选项:
|
| MVSep Oboe (oboe, other) | 77 | 键: add_opt2 名称: How to extract 选项:
|
| MVSep Clarinet (clarinet, other) | 78 | 键: add_opt2 名称: How to extract 选项:
|
| MVSep French Horn (french-horn, other) | 82 | 键: add_opt2 名称: How to extract 选项:
|
| MVSep Harmonica (harmonica, other) | 87 | 键: add_opt2 名称: How to extract 选项:
|
| MVSep Tuba (tuba, other) | 92 | |
| MVSep Bassoon (bassoon, other) | 93 | |
| MVSep Bagpipes (bagpipes , other) | 116 | 键: add_opt2 名称: How to extract 选项:
|
| 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 | 键: add_opt2 名称: How to extract 选项:
|
| MVSep Celesta (celesta, other) | 110 | 键: add_opt2 名称: How to extract 选项:
|
| MVSep Clap | 133 | |
| MVSep Cowbell | 128 | |
| MVSep Demucs4HT DNR (speech, music, effects) | 24 | 键: add_opt1 名称: Model type 选项:
|
| BandIt Plus (speech, music, effects) | 36 | |
| BandIt v2 (speech, music, effects) | 45 | 键: add_opt1 名称: Model Type 选项:
|
| MVSep DnR v3 (speech, music, effects) | 56 | 键: add_opt1 名称: Model type 选项:
键: add_opt2 名称: How to extract 选项:
键: add_opt3 名称: Output files 选项:
|
| MVSep Braam | 117 | |
| MVSep Risers | 125 | |
| MVSep FX | 122 | |
| Apollo Enhancers (by JusperLee, Lew, baicai1145) | 51 | 键: add_opt1 名称: Model type 选项:
键: add_opt2 名称: Cutoff (Hz) 选项:
|
| Reverb Removal (noreverb) | 22 | 键: add_opt1 名称: Model Type 选项:
键: add_opt2 名称: Preprocess 选项:
|
| DeNoise by aufr33 and gabox | 47 | 键: add_opt1 名称: Model type 选项:
|
| AudioSR (Super Resolution) | 59 | 键: add_opt1 名称: Cutoff (Hz) 选项:
|
| FlashSR (Super Resolution) | 60 | |
| Stable Audio Open Gen | 62 | 键: add_opt1 名称: Text prompt 选项: 键: add_opt2 名称: Length (in seconds) 选项:
|
| Whisper (extract text from audio) | 39 | 键: add_opt1 名称: Model type 选项:
键: add_opt2 名称: Transcription type 选项:
|
| Parakeet (extract text from audio) | 64 | 键: add_opt1 名称: Model type 选项:
键: add_opt2 名称: Version 选项:
|
| VibeVoice (Voice Cloning) | 103 | 键: add_opt1 名称: Model type 选项:
键: add_opt2 名称: Text prompt 选项: 键: add_opt3 名称: Extract vocals first 选项:
|
| VibeVoice (TTS) | 104 | 键: add_opt1 名称: Model type 选项:
键: add_opt2 名称: Text prompt 选项: |
| Qwen3-TTS (Custom Voice) | 118 | 键: add_opt1 名称: Text prompt 选项: 键: add_opt2 名称: Speaker 选项:
键: add_opt3 名称: Language 选项:
键: add_opt4 名称: Voice description 选项: |
| Qwen3-TTS (Voice Design) | 119 | 键: add_opt1 名称: Text prompt 选项: 键: add_opt2 名称: Voice description 选项: 键: add_opt3 名称: Language 选项:
|
| Qwen3-TTS (Voice Cloning) | 120 | 键: add_opt1 名称: Text prompt 选项: 键: add_opt2 名称: Reference text in audio (optional) 选项: 键: add_opt3 名称: Language 选项:
键: add_opt4 名称: Extract vocals first 选项:
|
| Mega 53-stem Model | 126 | |
| Bark (Speech Gen) | 115 | 键: add_opt1 名称: Text prompt 选项: 键: add_opt2 名称: Speaker 选项:
|
| MVSep MultiSpeaker (MDX23C) | 42 | 键: add_opt1 名称: Model Type 选项:
|
| Aspiration (by Sucial) | 50 | 键: add_opt1 名称: Model type 选项:
|
| Phantom Centre extraction | 55 | 键: add_opt1 名称: Model type 选项:
|
| Matchering (by sergree) | 68 | |
| SOME (Singing-Oriented MIDI Extractor) | 80 | 键: add_opt1 名称: How to use 选项:
|
| Transkun (Piano -> MIDI) | 113 | 键: add_opt1 名称: How to extract 选项:
|
| Basic Pitch (MIDI Extraction) | 114 | |
| ADTOF Plus (Drums -> MIDI) | 127 | 键: add_opt1 名称: How to extract 选项:
|
| HeartMuLa (Song Gen) | 121 | 键: add_opt1 名称: Lyrics 选项: 键: add_opt10 名称: Topic 选项:
键: add_opt2 名称: Tags (optional) 选项: 键: add_opt3 名称: Genre 选项:
键: add_opt4 名称: Timbre 选项:
键: add_opt5 名称: Gender 选项:
键: add_opt6 名称: Mood 选项:
键: add_opt7 名称: Instrument 选项:
键: add_opt8 名称: Scene 选项:
键: add_opt9 名称: Region 选项:
|
| Demucs3 Model (vocals, drums, bass, other) | 10 | 键: add_opt1 名称: Model type 选项:
|
| MDX A/B (vocals, drums, bass, other) | 7 | 键: add_opt1 名称: Vocal model type 选项:
|
| Vit Large 23 (vocals, instrum) | 33 | 键: add_opt1 名称: Model type 选项:
|
| UVRv5 Demucs (vocals, music) | 17 | 键: add_opt1 名称: Model Type 选项:
|
| 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 | 键: add_opt1 名称: Model type 选项:
|
| UnMix | 3 | 键: add_opt1 名称: Model type 选项:
|
| Zero Shot (Query Based) (Low quality) | 14 | 键: add_opt1 名称: Model Type 选项:
|
| LarsNet (kick, snare, cymbals, toms, hihat) | 38 | 键: add_opt1 名称: Model type 选项:
|
| 名称 | 值 |
|---|---|
| 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 | 字符串 | 此分离的哈希值 |
| mirror | 整数 | （可选）如果设置为 1，则使用另一个镜像，默认为 0。需要 api_token 和 1 个积分（如果设置为 1）。 |
| api_token | 字符串 | （可选）用户的 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 时显示） |
若要获取远程任务的结果，您需要对以下 URL 发起 GET 请求：
https://mvsep.com/api/separation/get-remote
| 字段 | 类型 | 说明 |
|---|---|---|
| hash | 字符串 | 此分离的哈希值 |
curl --location --request GET 'https://mvsep.com/api/separation/get-remote?hash=n2AwBjy4KsFZfqqR'
| 键 | 值 |
|---|---|
| success |
|
| status |
|
| data | 根据 status 键保存额外信息 |
| data -> queue_count | 显示用户优先级中未处理的任务数量（仅在 status 为 waiting 时显示）。 |
| data -> current_order | 显示用户任务的排队顺序（仅在 status 为 waiting 时显示）。 |
| data -> message | 显示状态描述（仅在 status 为 failed 时显示）。 |
| data -> link | 显示已创建任务的“获取结果”URL 链接（仅在 status 为 done 时显示）。 |
| data -> hash | 分离任务的哈希值（仅在 status 为 done 时显示）。 |
若要取消分离并退回所消耗的积分（仅限任务尚未开始处理的情况），您需要对以下 URL 发起 POST 请求：
https://mvsep.com/api/separation/cancel
| 字段 | 类型 | 说明 |
|---|---|---|
| api_token | 字符串 | 用户 API 密钥 |
| hash | 字符串 | 此分离的哈希值 |
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 | 字符串 | 是否包含使用不同输入形式的模型。
single_upload。若要获取所有模型，请设置 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 | 包含算法所属算法组的信息。 |
| algorithm_group -> name | 算法组名称。 |
| audio_widget |
用于该算法的音频组件类型。这可用于确定前端如何显示该算法的音频播放器。可能的值包括：
|
| orientation |
此分离类型的对象：
|
| order_id | 分离类型的顺序 |
| price_coefficient |
用于计算工作从高级用户那里消耗了多少积分。 使用此公式 : floor(<音频文件时长（秒）> * price_coefficient / 60)?:1
|
| usage | 显示分离类型的月度使用次数 |
| rating | 以数组形式显示分离类型的月度使用评分：
|
| 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 | 字符串 | （可选）2 个字母的语言代码（en, ru） |
| start | 整数 | （可选）起始点偏移量，默认为 0（即从最新开始） |
| limit | 整数 | （可选）返回的最大结果数量，默认为 10，最大为 20。 |
curl --location --request GET 'https://mvsep.com/api/app/news?lang=en&start=2&limit=1'
以数组形式，返回数据:
| 键 | 值 |
|---|---|
| title | 新闻标题 |
| lang | 新闻标题 |
| text | 新闻的完整描述 |
| created_at | 新闻日期 |
若要获取站点队列信息，您需要对以下 URL 发起 GET 请求：
https://mvsep.com/api/app/queue
| 字段 | 类型 | 说明 |
|---|---|---|
| api_token | 字符串 | （可选） 用户 API 密钥 |
curl --location --request GET 'https://mvsep.com/api/app/queue'
| 键 | 值 |
|---|---|
| queue |
包含不同套餐的当前队列数组：
|
| plan |
包含当前套餐的当前队列（在请求中添加 api_token 以获取注册/Premium 套餐信息）：
|
获取关于演示分离的信息，您需要向以下 URL 发起 GET 请求：
https://mvsep.com/api/app/demo
| 字段 | 类型 | 说明 |
|---|---|---|
| start | 整数 | （可选）起始点偏移量，默认为 0（即从最新开始） |
| limit | 整数 | （可选）返回的最大结果数量，默认为 10，最大为 20。 |
| algorithm_id | 整数 | 可选的分离类型 ID。使用此项仅返回由特定算法创建的演示分离。取值应匹配“获取分离类型”接口返回的 render_id。 |
| options[FIELD] | 字符串 / 整数 | 可选的算法选项值过滤器。将 FIELD 替换为“获取分离类型”响应中 algorithm_fields -> name 里的附加字段键，然后传入该字段 options 键中的一个值。例如：options[vocals]=1。 |
| additional_options | 字符串 | 针对存储的任务选项数据进行可选的原始包含过滤。对于新集成，建议优先使用 options[FIELD]，因为它更明确且更易于构建。 |
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'
若要构建选项过滤器，请先调用 https://mvsep.com/api/app/algorithms 并检查每个算法的 algorithm_fields 列表。在 options[FIELD] 中使用字段名 name，并使用 JSON 选项键中的一个作为值。
以数组形式，返回数据:
| 键 | 值 |
|---|---|
| hash | 此分离的哈希值 |
| date | 分离日期 |
| input_audio | 输入音频 URL |
| size | 输入音频大小 |
| algorithm | 包含有关已用分离类型的简要信息（有关返回参数的信息，请参阅“获取分离类型”选项） |
您需要向以下 URL 发送 POST 请求以验证用户并获取用户的 API 密钥：
https://mvsep.com/api/app/login
| 字段 | 类型 | 说明 |
|---|---|---|
| 字符串 | 用户电子邮件 | |
| password | 字符串 | 用户密码 |
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 | 字符串 | 用户名称 |
| 字符串 | 用户电子邮件 | |
| password | 字符串 | 用户密码 |
| password_confirmation | 字符串 | 重复用户密码 |
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 | 字符串 | 用户 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 | 字符串 | 用户 API 密钥 |
| start | 整数 | （可选）起始点偏移量，默认为 0（即从最新开始） |
| limit | 整数 | （可选）返回的最大结果数量，默认为 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 | 字符串 | 用户 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 | 字符串 | 用户 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 | 字符串 | 用户 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 | 字符串 | 用户 API 密钥 |
curl --location --request POST 'https://mvsep.com/api/app/disable_long_filenames' --form 'api_token="<您的 API 令牌>"'
| 键 | 值 |
|---|---|
| success |
|
| message | 通知操作状态 |
MVSEP API 使用以下错误代码：
| 错误代码 | 含义 |
|---|---|
| 400 | 无效的 API 密钥 |
若要获取有关质量检查器队列条目的信息，您需要对以下 URL 发起 GET 请求：
https://mvsep.com/api/quality_checker/queue
| 字段 | 类型 | 说明 |
|---|---|---|
| start | 整数 | （可选）起始点偏移量，默认为 0（即从最新开始） |
| limit | 整数 | （可选）返回的最大结果数量，默认为 10，最大为 20。 |
curl --location --request GET 'https://mvsep.com/api/quality_checker/queue?&start=1&limit=2'
以数组形式，返回数据:
| 键 | 值 |
|---|---|
| id | 条目识别号 |
| dataset_type | 添加条目时选择的数据集类型 / 排行榜类型
|
| date | 条目创建日期 |
| algo_name | 所使用的分离类型/算法名称 |
| main_text | 所使用的分离类型/算法描述 |
| proc | 处理状态
|
| proc_remote_date | 处理日期的时间戳 |
| msg | 成功时返回 "OK"，否则显示错误消息 |
| metrics | 条目指标信息 |
| sdr_* (wildcard) | 对应分轨的 SDR（信源失真比） |
| dataset_name | 数据集名称 |
若要获取有关质量检查器排行榜的信息，您需要对以下 URL 发起 GET 请求：
https://mvsep.com/api/quality_checker/leaderboard
| 字段 | 类型 | 说明 |
|---|---|---|
| dataset_type | 字符串 | 数据集类型，如果未给定，默认为 0。
|
| start | 整数 | （可选）起始点偏移量，默认为 0（即从最新开始） |
| limit | 整数 | （可选）返回的最大结果数量，默认为 10，最大为 20。 |
| algo_name_filter | 字符串 | 按给定的文本过滤分离类型/算法名称 |
| sort | 字符串 | 按给定分轨的 SDR 进行排序。您可以从响应中的 sortables 键获取给定数据集类型的可排序值列表。 |
curl --location --request GET 'https://mvsep.com/api/quality_checker/leaderboard?&start=1&limit=2&algo_name_filter=MVSep'
| 键 | 值 |
|---|---|
| data | 包含质量检查器条目的数组。更多信息请参阅“质量检查工具”部分的“获取队列”响应。 |
| dataset_type | 所使用的数据集类型键 |
| sortables | 可用于按给定分轨顺序对所选数据集类型进行排序的键。 |
| sort | 所使用的排序键。 |
若要创建质量检查器条目，您需要对以下 URL 发起 POST 请求：
https://mvsep.com/api/quality_checker/add
| 字段 | 类型 | 说明 |
|---|---|---|
| api_token | 字符串 | （必填） 您的 API Key |
| zipfile | 二进制 | （必填） 待处理的 Zip 文件 |
| algo_name | 字符串 | （必填） 算法名称 |
| main_text | 字符串 | （必填） 算法描述 |
| dataset_type | 字符串 | 数据集类型。默认为 0。
|
| password | 字符串 | （必填） 删除算法所需的密码 |
| ensemble | 整数 | 0 - 算法不是 集成模型 (ensemble)。1 - 算法是 集成模型 (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 | 包含条目信息 |
| data -> id | 条目 ID |
| data -> link | 条目链接 |
MVSEP API 使用以下错误代码：
| 错误代码 | 含义 |
|---|---|
| 400 | 表单无效 |
| 401 |
未知或无效的api_token。如果您使用了未知的API密钥，则会出现此错误。
|
若要通过 ID 获取有关质量检查器队列条目的信息，您需要对以下 URL 发起 GET 请求：
https://mvsep.com/api/quality_checker/entry
| 字段 | 类型 | 说明 |
|---|---|---|
| id | 整数 | （必填） 条目 ID |
curl --location --request GET 'https://mvsep.com/api/quality_checker/entry?id=7675'
若要通过 ID 和密码删除质量检查器队列条目，您需要对以下 URL 发起 GET 请求：
https://mvsep.com/api/quality_checker/delete
| 字段 | 类型 | 说明 |
|---|---|---|
| id | 整数 | （必填） 条目 ID |
| password | 字符串 | （必填） 条目所使用的密码 |
curl --location 'https://mvsep.com/api/quality_checker/delete' --form 'id="7720"' --form 'password="test"'
| 键 | 值 |
|---|---|
| success |
|
| data->message | 显示条目是否已被删除 |
turbo@mvsep.com