跳转到主要内容
POST

参数使用指南

此端点支持两种指定源音频的模式: 模式一:使用已有音频进行分区替换
  • 需要提供 taskIdaudioId
  • 不能提供 uploadUrlmodel
模式二:使用用户上传音频进行分区替换
  • 需要提供 uploadUrlmodel
  • 不能提供 taskIdaudioId

公共必需参数

  • prompt(string,必填):替换后的歌词
  • tags(string,必填):音乐的风格标签,如爵士、电子等
  • title(string,必填):音乐的标题
  • infillStartS(number,必填):开始替换的时间点(秒,保留2位小数)
  • infillEndS(number,必填):结束替换的时间点(秒,保留2位小数)
  • fullLyrics(string,必填):修改后的完整歌词,包含修改和未修改歌词的合并

可选参数

以下字段为可选控制项:
  • negativeTags(string):排除的音乐风格,用于避免特定风格元素出现在替换片段中
  • callBackUrl(string):生成任务完成后的回调URL。详细回调格式请参见 替换音乐分区回调

时间范围说明

  • infillStartS 必须小于 infillEndS
  • 时间值精确到小数点后 2 位,例如:10.50
  • 替换时间范围必须在 6 秒到 60 秒 之间
  • 替换时长建议不超过原音乐总时长的 50%

开发者注意事项

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

授权

Authorization
string
header
必填

🔑 API 认证说明

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

获取 API Key

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

使用方式

在请求头中添加:

⚠️ 注意:

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

请求体

application/json
taskId
string
必填

原始任务ID(父任务),用于标识要进行分区替换的源音乐。

示例:

"2fac****9f72"

audioId
string
必填

要替换的音频曲目的唯一标识符。此ID在音乐生成完成后的回调数据中返回。

示例:

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

prompt
string
必填

替换后的歌词

示例:

"A calm and relaxing piano track."

tags
string
必填

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

示例:

"Jazz"

title
string
必填

音乐的标题

示例:

"Relaxing Piano"

infillStartS
number
必填

开始替换的时间点(秒),保留2位小数。必须小于 infillEndS,且 infillEndS 与 infillStartS 的时间差必须在 6 秒到 60 秒之间。

必填范围: x >= 0
示例:

10.5

infillEndS
number
必填

结束替换的时间点(秒),保留2位小数。必须大于 infillStartS,且 infillEndS 与 infillStartS 的时间差必须在 6 秒到 60 秒之间。

必填范围: x >= 0
示例:

20.75

fullLyrics
string
必填

修改后的完整歌词,包含修改和未修改歌词的合并。此参数包含在分区替换后整首歌曲将使用的完整歌词文本。

示例:

"[主歌1]\n原始歌词内容\n[副歌]\n此部分的修改歌词\n[主歌2]\n更多原始歌词"

negativeTags
string

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

示例:

"Rock"

callBackUrl
string<uri>

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

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

"https://example.com/callback"

回调

POST
{request.body#/callBackUrl}audioGenerated

请求体

application/json
code
integer

状态码

示例:

200

msg
string

返回消息

示例:

"All generated successfully"

data
object

响应

200 - application/json

回调接收成功

code
enum<integer>

响应状态码

  • 200: 成功 - 请求已成功处理
  • 400: 验证错误 - 歌词包含受版权保护的内容。
  • 408: 超出限制 - 超时。
  • 413: 冲突 - 上传的音频与现有艺术作品匹配。
  • 500: 服务器错误 - 处理请求时发生意外错误
  • 501: 音频生成失败。
  • 531: 服务器错误 - 抱歉,由于问题生成失败。您的积分已退还。请重试。
可用选项:
200,
400,
408,
413,
500,
501,
531
msg
string

当 code != 200 时的错误信息

示例:

"success"

响应

请求成功

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 时的错误信息

示例:

"success"

data
object