跳转到主要内容
POST
/
api
/
v1
/
generate
/
upload-cover
上传并翻唱音乐
curl --request POST \
  --url https://api.sunoapi.org/api/v1/generate/upload-cover \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "uploadUrl": "https://api.example.com/upload",
  "prompt": "一段平静舒缓的钢琴曲,带有柔和的旋律",
  "style": "古典",
  "title": "宁静钢琴冥想",
  "customMode": true,
  "instrumental": true,
  "personaId": "persona_123",
  "model": "V3_5",
  "negativeTags": "重金属, 强节奏鼓点",
  "vocalGender": "m",
  "styleWeight": 0.65,
  "weirdnessConstraint": 0.65,
  "audioWeight": 0.65,
  "callBackUrl": "https://api.example.com/callback"
}'
{
  "code": 200,
  "msg": "success",
  "data": {
    "taskId": "5c79****be8e"
  }
}

参数使用指南

  • 当 customMode 为 true(自定义模式)时:
    • 如果 instrumental 为 true:需要提供 style、title 和 uploadUrl
    • 如果 instrumental 为 false:需要提供 style、prompt、title和uploadUrl
    • prompt 根据模型的长度限制:
      • V3_5 和 V4:最大 3000 字符
      • V4_5、V4_5PLUS 和 V5:最大 5000 字符
    • style 根据模型的长度限制:
      • V3_5 和 V4:最大 200 字符
      • V4_5、V4_5PLUS 和 V5:最大 1000 字符
    • title 根据模型的长度限制:
      • V3_5 和 V4:最大 80 字符
      • V4_5、V4_5PLUS 和 V5:最大 100 字符
    • uploadUrl 用于指定音频文件的上传位置;确保上传的音频长度不超过 8 分钟。
  • 当 customMode 为 false(非自定义模式)时:
    • 无论 instrumental 设置如何,只需要提供 prompt和uploadUrl
    • prompt 长度限制:500字符
    • 其他参数应留空

开发者注意事项

  1. 新用户推荐设置:将 customMode 设为 false,instrumental 设为 false,只提供 prompt和uploadUrl。这是最简单的配置,可以快速测试API并体验结果。
  2. 生成的文件将保留15天后删除
  3. 请根据 customMode 和 instrumental 设置确保提供所有必要参数,避免出错
  4. 请注意 prompt、style 和 title 的字符长度限制,确保成功处理
  5. 回调过程有三个阶段:text(文本生成完成)、first(第一首完成)、complete(全部完成)
  6. 您可以使用音乐生成详情查询接口主动检查任务状态,而不必等待回调
  7. uploadUrl 参数用于指定音频文件的上传位置;请提供有效的 URL。

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
uploadUrl
string<uri>
required

用于上传音频文件的 URL,无论 customMode 和 instrumental 是 true 还是 false,都是必需的。确保上传的音频长度不超过 2 分钟。

Example:

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

customMode
boolean
required

启用自定义模式进行高级音频生成设置。

  • 设为 true 使用自定义模式(需要提供 styletitle;如果 instrumentalfalse,则需要提供 prompt)。如果 instrumentalfalse,提示词将严格用作歌词。
  • 设为 false 使用非自定义模式(只需要提供 prompt)。歌词将根据提示词自动生成。
Example:

true

instrumental
boolean
required

决定音频是否为纯音乐(无歌词)。

  • 在自定义模式下(customMode: true):
    • 如果为 true:只需提供 styletitle
    • 如果为 false:需要提供 styletitlepromptprompt 将作为精确歌词使用)。
  • 在非自定义模式下(customMode: false):不影响必填字段(只需 prompt)。如果为 false,将自动生成歌词。
Example:

true

model
enum<string>
required

用于音频生成的模型版本。

  • 可选择:V3_5V4V4_5V4_5PLUSV5注意: 确保格式正确(例如,使用 "V3_5" 或 "V4",而不是 "V3.5" 或其他变体)。
可用选项:
V3_5,
V4,
V4_5,
V4_5PLUS,
V5
Example:

"V3_5"

callBackUrl
string<uri>
required

接收任务完成通知的URL。回调过程有三个阶段:text(文本生成)、first(第一首完成)、complete(全部完成)。注意:某些情况下可能会跳过 textfirst 阶段,直接返回 complete

详细的回调格式和实现指南,请参见 上传并翻唱音频回调

  • 或者,您也可以使用获取音乐生成详情接口来轮询任务状态
Example:

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

prompt
string

描述期望生成的音频内容。

  • 在自定义模式下(customMode: true):当 instrumentalfalse 时必填。提示词将严格用作歌词并在生成的音乐中演唱。根据模型的字符限制:
    • V3_5 和 V4:最大 3000 字符
    • V4_5、V4_5PLUS 和 V5:最大 5000 字符
      示例:"一段平静舒缓的钢琴曲,带有柔和的旋律"
  • 在非自定义模式下(customMode: false):始终必填。提示词作为核心创意,歌词将基于此自动生成(不会严格匹配输入内容)。最大长度:500字符。
    示例:"一段短小舒缓的钢琴曲"
Example:

"一段平静舒缓的钢琴曲,带有柔和的旋律"

style
string

音乐风格或流派。

  • 在自定义模式下(customMode: true)必填。示例:"爵士"、"古典"、"电子"。
    • 对于 V3_5 和 V4 模型:最大长度:200字符。
    • 对于 V4_5、V4_5PLUS 和 V5 模型:最大长度:1000字符。 示例:"古典"
  • 在非自定义模式下(customMode: false):留空。
Example:

"古典"

title
string

生成音乐的标题。

  • 在自定义模式下(customMode: true)必填。最大长度:80字符。
    示例:"宁静钢琴冥想"
  • 在非自定义模式下(customMode: false):留空。
Example:

"宁静钢琴冥想"

personaId
string

仅在开启自定义模式(customMode: true)时可用。应用到生成音乐的人格ID。可选。使用此参数为音乐生成应用特定的人格风格。

要生成人格ID,请使用 生成 Persona 接口,基于已生成的音乐创建个性化的音乐人格。

Example:

"persona_123"

negativeTags
string

需要在生成的音频中排除的音乐风格或特征。

  • 可选。用于避免特定风格。
    示例:"重金属, 强节奏鼓点"
Example:

"重金属, 强节奏鼓点"

vocalGender
enum<string>

期望的人声性别(可选)

可用选项:
m,
f
Example:

"m"

styleWeight
number

风格指引权重,范围 0.00–1.00

Required range: 0 <= x <= 1Must be a multiple of 0.01
Example:

0.65

weirdnessConstraint
number

创意发散/奇异度约束,范围 0.00–1.00

Required range: 0 <= x <= 1Must be a multiple of 0.01
Example:

0.65

audioWeight
number

输入音频影响力权重(如适用),范围 0.00–1.00

Required range: 0 <= x <= 1Must be a multiple of 0.01
Example:

0.65

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