KIE.AI
old-model
  • All Model
  • old-model
language
language
  • 🇺🇸 English
  • 🇨🇳 Chinese
language
language
  • 🇺🇸 English
  • 🇨🇳 Chinese
Support
old-model
  • All Model
  • old-model
old-model
  • All Model
  • old-model
Suno API
4o Image APIVeo3.1 APIRunway APIFlux Kontext API
Suno API
4o Image APIVeo3.1 APIRunway APIFlux Kontext API
  1. Music Generation
  • Suno API 快速开始
  • Music Generation
    • 音乐封面生成回调
    • 生成音乐回调
    • 音乐扩展回调
    • 音频上传和翻唱回调
    • 音频上传和扩展回调
    • 添加伴奏回调
    • 添加人声回调
    • 替换音乐分区回调
    • 生成音乐
      POST
    • 延长音乐
      POST
    • 上传并翻唱音乐
      POST
    • 上传并扩展音乐
      POST
    • 添加伴奏生成音乐
      POST
    • 添加人声生成音乐
      POST
    • 获取音乐任务详情
      GET
    • 获取带时间戳的歌词
      POST
    • 提升音乐风格
      POST
    • 替换音乐分区
      POST
    • 生成音乐封面
      POST
    • 获取音乐封面生成详情
      GET
    • 生成 Persona
      POST
    • 生成混音音乐
      POST
    • 恢复音频
      POST
  • Lyrics Generation
    • 生成歌词回调
    • 生成歌词
      POST
    • 获取歌词任务详情
      GET
  • WAV Conversion
    • 转换为WAV格式回调
    • 转换为WAV格式
    • 获取WAV转换详情
  • Vocal Removal
    • 音频分离回调
    • MIDI 生成回调
    • 人声和乐器分离
    • 获取人声和乐器分离详情
    • 从音频生成 MIDI
    • 获取 MIDI 生成详情
  • Music Video Generation
    • MP4生成完成回调
    • 创建音乐视频
    • 获取音乐视频详情
  • Sounds Generation
    • 生成声音
  • voice
    • Suno Voice 生成回调
    • Suno Voice 验证短句回调
    • Suno Voice生成验证短句接口
    • Suno Voice获取验证短句接口
    • Suno Voice自建音色生成接口
    • Suno Voice获取自建音色记录
    • Suno Voice 重新生成验证短句
    • Suno Voice检查是否可用接口
  1. Music Generation

添加人声回调

当人声生成完成时,系统会调用此回调通知结果。
当您向Suno API的 /api/v1/generate/add-vocals 接口提交人声生成任务时,可以使用 callBackUrl 参数设置回调URL。任务完成时,系统将自动向您指定的地址推送结果。

相关API接口#

此回调由以下API接口触发:
添加人声接口
POST /api/v1/generate/add-vocals - 为上传的音乐文件添加人声

回调机制概述#

Webhook 安全性:为确保回调请求的真实性和完整性,我们强烈建议您实现 webhook 签名验证。请参阅我们的 Webhook 校验指南 了解详细实现步骤。
回调机制消除了轮询API获取任务状态的需要。系统会主动向您的服务器推送任务完成结果。

回调时机#

系统将在以下情况发送回调通知:
文本生成完成(callbackType: "text")
第一个音频轨道生成完成(callbackType: "first")
所有音频轨道生成完成(callbackType: "complete")
人声生成任务失败
任务处理过程中发生错误

回调方式#

HTTP方法: POST
内容类型: application/json
超时设置: 15秒

回调请求格式#

当任务进行或完成时,系统将以下格式向您的 callBackUrl 发送POST请求:
完成成功回调
第一首成功回调
文本生成回调
失败回调
{
  "code": 200,
  "msg": "All generated successfully.",
  "data": {
    "callbackType": "complete",
    "task_id": "2fac****9f72",
    "data": [
      {
        "id": "e231****-****-****-****-****8cadc7dc",
        "audio_url": "https://example.cn/****.mp3",
        "stream_audio_url": "https://example.cn/****",
        "image_url": "https://example.cn/****.jpeg",
        "prompt": "[Verse] 夜晚城市 灯火辉煌",
        "model_name": "chirp-v4-5",
        "title": "钢铁侠",
        "createTime": 1786343609818,
        "duration": 198.44,
        "tags": "electrifying, rock",
        "source_audio_url":"https://example.cn/****.jpeg",
        "source_image_url":"https://example.cn/****.mp3",
        "source_stream_audio_url":"https://example.cn/****"
      },
      {
        "id": "e231****-****-****-****-****8cadc7dc",
        "audio_url": "https://example.cn/****.mp3",
        "stream_audio_url": "https://example.cn/****",
        "image_url": "https://example.cn/****.jpeg",
        "prompt": "[Verse] 夜晚城市 灯火辉煌",
        "model_name": "chirp-v4-5",
        "title": "钢铁侠",
        "createTime": 1786343609818,
        "duration": 198.44,
        "tags": "electrifying, rock",
        "source_audio_url":"https://example.cn/****.jpeg",
        "source_image_url":"https://example.cn/****.mp3",
        "source_stream_audio_url":"https://example.cn/****"
      }
    ]
  }
}

状态码说明#

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

msg (string, required)#

状态消息,提供详细的状态描述

data.callbackType (string, required)#

回调类型,表示生成阶段:
text: 文本生成完成
first: 第一首完成
complete: 全部完成
error: 生成失败

data.task_id(string,必填)#

任务 ID,与提交任务时返回的 task_id 一致。

data.data(array)#

生成的音频数据数组,成功时返回

data.data[].id(string)#

音频唯一标识。

data.data[].audio_url(string)#

音频文件 URL。

data.data[].stream_audio_url(string)#

流式音频 URL。

data.data[].image_url(string)#

封面图片 URL。

data.data[].prompt(string)#

生成提示词或歌词。

data.data[].model_name(string)#

用于生成音频的模型名称。

data.data[].title(string)#

音乐标题。

data.data[].tags(string)#

音乐标签。

data.data[].createTime(integer)#

创建时间,使用 Unix 时间戳表示,单位为毫秒。

data.data[].duration(number)#

音频时长,单位为秒。

data.data[].source_audio_url(string)#

源音频文件URL。

data.data[].source_image_url(string)#

源封面图片URL。

data.data[].source_stream_audio_url(string)#

源流式音频URL。

回调接收示例#

以下是常用编程语言的回调接收示例代码:
Node.js

最佳实践#

回调URL配置建议#

1.
使用HTTPS: 确保您的回调URL使用HTTPS协议,保证数据传输安全
2.
验证来源: 在回调处理中验证请求来源的合法性
3.
幂等处理: 同一个task_id可能会收到多次回调,确保处理逻辑具有幂等性
4.
快速响应: 回调处理应尽快返回200状态码,避免超时
5.
异步处理: 复杂的业务逻辑应异步处理,避免阻塞回调响应
6.
阶段跟踪: 根据callbackType区分不同生成阶段,合理安排业务逻辑

重要提醒#

回调URL必须是公网可访问的地址
服务器必须在15秒内响应,否则将被视为超时
如果连续3次重试失败,系统将停止发送回调
请确保回调处理逻辑的稳定性,避免因异常导致回调失败
注意处理不同callbackType的回调,特别是complete类型的最终结果

替代方案#

如果您无法使用回调机制,也可以使用轮询方式:
轮询查询结果
使用获取Cover详情端点定期查询任务状态。我们建议每30秒查询一次。
Previous
添加伴奏回调
Next
替换音乐分区回调
Built with