跳转到主要内容
POST
/
api
/
v1
/
generate
/
replace-section
替换音乐分区
curl --request POST \
  --url https://api.api.box/api/v1/generate/replace-section \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "taskId": "2fac****9f72",
  "musicIndex": 0,
  "prompt": "A calm and relaxing piano track.",
  "tags": "Jazz",
  "title": "Relaxing Piano",
  "negativeTags": "Rock",
  "infillStartS": 10.5,
  "infillEndS": 20.75,
  "callBackUrl": "https://example.com/callback"
}'
{
  "code": 200,
  "msg": "success",
  "data": {
    "taskId": "5c79****be8e"
  }
}

​
使用指南

  • 此接口可以替换已生成音乐中的特定时间段
  • 需要提供原始音乐的任务ID和要替换的时间范围
  • 替换后的音频会与原音乐自然融合

​
参数详情

  • 必需参数：
    • taskId：原始音乐的父任务ID
    • musicIndex：要替换的音乐索引（从生成的音乐列表中选择）
    • prompt：描述替换片段的提示词
    • tags：音乐风格标签
    • title：音乐标题
    • infillStartS：开始替换的时间点（秒，保留2位小数）
    • infillEndS：结束替换的时间点（秒，保留2位小数）
  • 可选参数：
    • negativeTags：要排除的音乐风格
    • callBackUrl：任务完成后的回调地址

​
时间范围说明

  • infillStartS 必须小于 infillEndS
  • 时间值精确到小数点后2位，例如：10.50秒
  • 替换时长建议不超过原音乐总时长的50%

​
开发者注意事项

  • 替换片段会根据提供的 prompt 和 tags 重新生成
  • 生成的替换片段会自动与原音乐前后部分融合
  • 生成的文件将保留14天
  • 查询任务状态使用与生成音乐相同的接口：获取音乐详情

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（父任务），用于标识要进行分区替换的源音乐

Example:

"2fac****9f72"

​
musicIndex
integer
required

音乐索引，指定要替换的是生成音乐列表中的第几首（从0开始）

Example:

0

​
prompt
string
required

生成替换片段的提示词，通常是描述音频内容的文本

Example:

"A calm and relaxing piano track."

​
tags
string
required

音乐的风格标签，如爵士、电子等

Example:

"Jazz"

​
title
string
required

音乐的标题

Example:

"Relaxing Piano"

​
infillStartS
number
required

开始替换的时间点（秒），保留2位小数。必须小于 infillEndS

Required range: x >= 0
Example:

10.5

​
infillEndS
number
required

结束替换的时间点（秒），保留2位小数。必须大于 infillStartS

Required range: x >= 0
Example:

20.75

​
negativeTags
string

排除的音乐风格，用于避免特定风格元素出现在替换片段中

Example:

"Rock"

​
callBackUrl
string<uri>

生成任务完成后的回调URL。系统将在替换完成时向此URL发送POST请求，包含任务状态和结果。

  • 您的回调端点应能接受包含替换结果的JSON载荷的POST请求
  • 详细的回调格式和实现指南，请参见 替换音乐分区回调
  • 或者，您也可以使用获取音乐详情接口来轮询任务状态
Example:

"https://example.com/callback"

Response

请求成功

​
code
enum<integer>

响应状态码

  • 200: 成功 - 请求已成功处理
  • 401: 未授权 - 身份验证凭据缺失或无效
  • 402: 积分不足 - 账户没有足够的积分执行此操作
  • 404: 未找到 - 请求的资源或端点不存在
  • 409: 冲突 - WAV记录已存在
  • 422: 验证错误 - 请求参数未通过验证检查
  • 429: 超出限制 - 已超过对此资源的请求限制
  • 451: 未授权 - 获取图像失败。请验证您或您的服务提供商设置的任何访问限制。
  • 455: 服务不可用 - 系统当前正在进行维护
  • 500: 服务器错误 - 处理请求时发生意外错误
可用选项:
200,
401,
402,
404,
409,
422,
429,
451,
455,
500
​
msg
string

当 code != 200 时的错误信息

Example:

"success"

​
data
object