跳转到主要内容
POST
/
api
/
v1
/
vocal-removal
/
generate
分离音乐中的人声
curl --request POST \
  --url https://api.api.box/api/v1/vocal-removal/generate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "taskId": "5c79****be8e",
  "audioId": "e231****-****-****-****-****8cadc7dc",
  "callBackUrl": "https://api.example.com/callback",
  "type": "separate_vocal"
}
'
{
  "code": 200,
  "msg": "success",
  "data": {
    "taskId": "5c79****be8e"
  }
}

​
使用指南

  • 此接口支持两种人声分离模式，可根据需求选择不同的分离类型
  • 适用于卡拉OK应用、混音、音乐制作或分离特定乐器以进行进一步处理
  • 对于有清晰人声和乐器部分的专业录制音乐效果最佳

​
分离类型说明

  • separate_vocal（默认）：分离人声和伴奏，生成人声轨道和伴奏轨道
    • 输出：人声轨道 + 伴奏轨道（无人声）
    • 适用于卡拉OK制作或基础人声分离需求
  • split_stem：分离各种乐器的声音
    • 输出：人声、鼓声、贝斯、吉他、键盘、弦乐、铜管、木管、打击乐、合成器、效果器、背景人声等多个轨道
    • 适用于专业音乐制作、混音或需要单独处理各种乐器的场景

​
参数详情

  • taskId：必填，标识原始音乐生成任务
  • audioId：必填，在存在多个变体时指定要处理的音频轨道
  • type：可选，指定分离类型
    • 可选值：separate_vocal、split_stem
    • 默认值：separate_vocal

​
开发者注意事项

  • 所有分离后的音频文件URL将保留14天
  • 分离质量取决于原始音轨的复杂度和混音情况
  • 所有输出文件均为MP3格式，质量与原始文件相同
  • 不同的 type 参数将返回不同数量和类型的音频轨道
  • 回调数据结构根据选择的分离类型而异

Authorizations

​
Authorization
string
header
required

🔑 API 认证说明

所有接口都需要通过 Bearer Token 方式进行认证。

获取 API Key

  1. 访问 API Key 管理页面 获取您的 API Key

使用方式

在请求头中添加：

Authorization: Bearer YOUR_API_KEY

⚠️ 注意：

  • 请妥善保管您的 API Key，不要泄露给他人
  • 如果怀疑 API Key 泄露，请立即在管理页面重置

Body

application/json
​
taskId
string
required

音乐生成任务的任务ID。

  • 必填。用于标识包含待处理音频的任务。
  • 需要同时提供 taskId 和 audioId 以精确识别音轨。
Example:

"5c79****be8e"

​
audioId
string
required

要分离的具体音频音轨的ID。

  • 必填。用于标识任务中要处理的具体音轨。
  • 需要同时提供 taskId 和 audioId 以精确识别音轨。
Example:

"e231****-****-****-****-****8cadc7dc"

​
callBackUrl
string<uri>
required

处理完成时接收人声分离结果的URL。

  • 必填。
  • 回调将包含不同类型的分离结果，根据 type 参数确定：
    • separate_vocal：包含人声和伴奏分离结果
    • split_stem：包含各种乐器分离结果

详细的回调格式和实现指南，请参见 人声分离回调

  • 或者，您也可以使用获取人声分离详情接口来轮询任务状态
Example:

"https://api.example.com/callback"

​
type
enum<string>
default:separate_vocal

人声分离类型。

  • 可选，默认值为 separate_vocal。
  • separate_vocal：分离人声和伴奏，生成人声轨道和伴奏轨道
  • split_stem：分离各种乐器声音，生成人声、背景人声、鼓声、贝斯、吉他、键盘、弦乐、铜管、木管、打击乐、合成器、效果器等多个轨道
可用选项:
separate_vocal,
split_stem
Example:

"separate_vocal"

Response

请求成功

​
code
enum<integer>

状态码说明

  • ✅ 200 - 请求成功
  • ⚠️ 400 - 参数错误
  • ⚠️ 401 - 没有访问权限
  • ⚠️ 404 - 请求方式或者路径错误
  • ⚠️ 405 - 调用超过限制
  • ⚠️ 413 - 主题或者prompt过长
  • ⚠️ 429 - 积分不足
  • ⚠️ 430 - 您的调用频率过高。请稍后再试。
  • ⚠️ 455 - 网站维护
  • ❌ 500 - 服务器异常
可用选项:
200,
400,
401,
404,
405,
413,
429,
430,
455,
500
Example:

200

​
msg
string

当 code != 200 时，展示错误信息

Example:

"success"

​
data
object