参数使用指南
- 对于模型 V5:style(最大1000字符)、title(最大100字符)、prompt(最大5000字符)
- 对于模型 V4_5PLUS 和 V4_5:style(最大1000字符)、title(最大100字符)、prompt(最大5000字符)
- 对于模型 V3_5 和 V4:style(最大200字符)、title(最大80字符)、prompt(最大3000字符)
-
当 customMode 为 true(自定义模式)时:
- 如果 instrumental 为 true:需要提供 style、title 和 uploadUrl
- 如果 instrumental 为 false:需要提供 style、prompt、title和uploadUrl
- 字符限制根据模型版本而异(见上方说明)
- uploadUrl 用于指定音频文件的上传位置;确保上传的音频长度不超过 8 分钟。
-
当 customMode 为 false(非自定义模式)时:
- 无论 instrumental 设置如何,只需要提供 prompt和uploadUrl
- prompt 长度限制:500字符
- 其他参数应留空
开发者注意事项
- 新用户推荐设置:将 customMode 设为 false,instrumental 设为 false,只提供 prompt和uploadUrl。这是最简单的配置,可以快速测试API并体验结果。
- 生成的文件将保留15天后删除
- 请根据 customMode 和 instrumental 设置确保提供所有必要参数,避免出错
- 请注意 prompt、style 和 title 的字符长度限制,确保成功处理
- 回调过程有三个阶段:text(文本生成完成)、first(第一首完成)、complete(全部完成)
- 您可以使用音乐生成详情查询接口主动检查任务状态,而不必等待回调
- uploadUrl 参数用于指定音频文件的上传位置;请提供有效的 URL。
可选参数
vocalGender(string): 人声性别偏好。m男声,f女声。styleWeight(number): 对风格的遵循强度。范围 0–1,保留两位小数。示例:0.65。weirdnessConstraint(number): 创意/离散程度。范围 0–1,保留两位小数。示例:0.65。audioWeight(number): 音频要素权重。范围 0–1,保留两位小数。示例:0.65。personaId(string): 应用到生成音乐的personaId。仅在开启自定义模式时可用。生成personaId请访问生成 Persona。
Authorizations
所有接口都需要通过 Bearer Token 方式进行认证。
获取 API Key:
- 访问 API Key 管理页面 获取您的 API Key
使用方式: 在请求头中添加: Authorization: Bearer YOUR_API_KEY
注意事项:
- 请妥善保管您的 API Key,不要泄露给他人
- 如果怀疑 API Key 泄露,请立即在管理页面重置
Body
用于上传音频文件的 URL,无论 customMode 和 instrumental 是 true 还是 false,都是必需的。确保上传的音频长度不超过 2 分钟。
"https://api.example.com/upload"
启用自定义模式进行高级音频生成设置。
- 设为
true使用自定义模式(需要提供style和title;如果instrumental为false,则需要提供prompt)。如果instrumental为false,提示词将严格用作歌词。 - 设为
false使用非自定义模式(只需要提供prompt)。歌词将根据提示词自动生成。
true
决定音频是否为纯音乐(无歌词)。
- 在自定义模式下(
customMode: true):- 如果为
true:只需提供style和title。 - 如果为
false:需要提供style、title和prompt(prompt将作为精确歌词使用)。
- 如果为
- 在非自定义模式下(
customMode: false):不影响必填字段(只需prompt)。如果为false,将自动生成歌词。
true
用于生成的AI模型版本。
- 所有请求都必填。
- 可用选项:
V5: 更卓越的音乐表现力,生成速度更快。V4_5PLUS:V4.5+ 音色更丰富,新的创作方式,最长8分钟。V4_5:V4.5 更智能的提示词,更快的生成速度,最长8分钟。V4:V4 改进的人声质量,最长4分钟。V3_5:V3.5 更好的歌曲结构,最长4分钟。
V3_5, V4, V4_5, V4_5PLUS, V5 "V3_5"
用于接收音频覆盖任务完成更新的URL地址。所有音频覆盖请求都需要此参数。
- 系统将在音频覆盖完成时向此URL发送POST请求,包含任务状态和结果
- 回调过程有三个阶段:
text(文本生成)、first(第一首完成)、complete(全部完成) - 您的回调端点应能接受包含音频覆盖结果的JSON载荷的POST请求
- 详细的回调格式和实现指南,请参见 音频覆盖回调
- 或者,您也可以使用获取音乐详情接口来轮询任务状态
- 注意:某些情况下可能会跳过
text和first阶段,直接返回complete
"https://api.example.com/callback"
描述期望生成的音频内容。
- 在自定义模式下(
customMode: true):当instrumental为false时必填。提示词将严格用作歌词并在生成的音乐中演唱。字符限制根据模型版本:- V5:最大5000字符
- V4_5PLUS & V4_5:最大5000字符
- V3_5 & V4:最大3000字符
示例:"一段平静舒缓的钢琴曲,带有柔和的旋律"
- 在非自定义模式下(
customMode: false):始终必填。提示词作为核心创意,歌词将基于此自动生成(不会严格匹配输入内容)。最大长度:500字符。
示例:"一段短小舒缓的钢琴曲"
"一段平静舒缓的钢琴曲,带有柔和的旋律"
音乐风格或流派。
- 在自定义模式下(
customMode: true)必填。示例:"爵士"、"古典"、"电子"。字符限制根据模型版本:- V5:最大1000字符
- V4_5PLUS & V4_5:最大1000字符
- V3_5 & V4:最大200字符
示例:"古典"
- 在非自定义模式下(
customMode: false):留空。
"古典"
生成音乐的标题。
- 在自定义模式下(
customMode: true)必填。字符限制根据模型版本:- V5:最大100字符
- V4_5PLUS & V4_5:最大100字符
- V3_5 & V4:最大80字符
示例:"宁静钢琴冥想"
- 在非自定义模式下(
customMode: false):留空。
"宁静钢琴冥想"
需要在生成的音频中排除的音乐风格或特征。
- 可选。用于避免特定风格。
示例:"重金属, 强节奏鼓点"
"重金属, 强节奏鼓点"
人声性别偏好。可选。'm' 表示男声,'f' 表示女声。注意:此参数仅在customMode为true时生效。根据实践,此参数只能加强概率,但不能保证一定遵循男女声的指令。
m, f "m"
对指定风格的遵循强度。可选。范围 0–1,保留两位小数。
0 <= x <= 1Must be a multiple of 0.010.65
控制实验性/创意偏离程度。可选。范围 0–1,保留两位小数。
0 <= x <= 1Must be a multiple of 0.010.65
音频要素相对权重。可选。范围 0–1,保留两位小数。
0 <= x <= 1Must be a multiple of 0.010.65
仅在开启自定义模式(customMode: true)时可用。应用到生成音乐的人格ID。可选。使用此参数为音乐生成应用特定的人格风格。
要生成人格ID,请使用 生成 Persona 接口,基于已生成的音乐创建个性化的音乐人格。
"persona_123"
Response
请求成功
响应状态码
- 200: 成功 - 请求已成功处理
- 401: 未授权 - 身份验证凭据缺失或无效
- 402: 积分不足 - 账户没有足够的积分执行此操作
- 404: 未找到 - 请求的资源或端点不存在
- 409: 冲突 - WAV记录已存在
- 422: 验证错误 - 请求参数未通过验证检查
- 429: 超出限制 - 已超过对此资源的请求限制
- 451: 未授权 - 获取图像失败。请验证您或您的服务提供商设置的任何访问限制。
- 455: 服务不可用 - 系统当前正在进行维护
- 500: 服务器错误 - 处理请求时发生意外错误
200, 401, 402, 404, 409, 422, 429, 451, 455, 500 当 code != 200 时的错误信息
"success"
