文档 / 音乐系列 / Suno / 辅助功能
辅助功能POSTSunoWAVEFORManalysissuno_waveform
获取波形聚合数据
获取已生成 clip 的多分辨率波形数据。
Bearer API KeyJSON服务端调用
用途#
提交一个 波形聚合数据（WAVEFORM） 任务，获取 clip 的多分辨率波形聚合数据，适合在前端绘制波形图。接口为异步模式：服务在校验通过后立即返回公开 task_id，不会等待任务完成。后续通过 GET /v1/tasks/:id 轮询任务状态与结果。
该动作是只读分析，不会改变源音频。返回的多级（mip-map）聚合数据便于在不同缩放层级下高效渲染波形。
clip_id 必须来自本服务已完成的历史任务，否则请求会失败。
请求字段#
| 字段 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
clip_id | string | 是 | — | 目标 clip 的 UUID，必须来自本服务已完成的历史任务 |
callback_url | string | 否 | — | 任务到达终态时的回调通知地址 |
clip_id 为必填项。缺失时返回 400 clip_id_empty。
callback_url 必须是公网可访问的 HTTPS 地址，长度不超过 2048 字符；禁止使用本机、内网、回环、链路本地地址，也禁止使用解析到这些地址的域名。
任务完成或失败后，服务会向该地址发送 POST JSON。回调接收端须在 10 秒内返回任意 2xx 状态码；超时、网络错误或非 2xx 响应均视为失败。
失败后会分别等待 1 秒、2 秒和 4 秒重试，连同首次请求最多发送 4 次。接收端应使用任务 ID 做幂等处理，避免重复处理。
请求示例#
cURL
curl --request POST \
--url https://api.apimax.ai/v1/music/waveform \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"clip_id": "1f78f8de-4ca6-4375-ae79-46c33a2c97f7"
}'成功响应#
200
{
"code": "success",
"message": "",
"data": "task_01HV7..."
}响应字段#
| 字段 | 类型 | 说明 |
|---|---|---|
code | string | 响应码，成功固定为 success |
message | string | 提示信息，成功时通常为空 |
data | string | 公开任务 ID（40 字符以内），用于后续查询 |
data 返回公开 task_id，所有后续查询均使用该 ID。
错误码#
| HTTP | code | 场景 |
|---|---|---|
| 400 | invalid_request | 请求体 JSON 解析失败 |
| 400 | clip_id_empty | 未提供 clip_id |
| 400 | invalid_action | action 不在支持列表内 |
| 503 | no_available_channel | 无可用渠道 |
| 502 | upstream_failed | 任务处理服务请求失败（网络错误等） |
查询任务结果#
提交成功后，使用返回的 task_id 轮询：
- 单个查询：
GET /v1/tasks/:id
status 枚举#
| 值 | 说明 |
|---|---|
queued | 任务已创建，等待处理 |
in_progress | 任务正在处理 |
completed | 任务处理完成，可读取 data |
failed | 任务处理失败，可读取 error |
completed 和 failed 为终态；其余状态请继续轮询。
查询结果中的 data 字段包含波形聚合数据：
json
{
"id": "task_IKO8PAN7zimncosvptgGMP2RFy1vllKy",
"model": "suno_waveform",
"object": "task",
"platform": "suno",
"type": "suno",
"status": "completed",
"progress": 100,
"created_at": 1783072840,
"started_at": 1783072841,
"finished_at": 1783072852,
"data": [
{
"waveform_aggregates": [
{
"mip_map_level": 19,
"data": [
[-39, 2, -24, 19, -4096, 2476, -5413, 4761],
[-6478, 8712, -17296, 17630, -27457, 22314, -24350, 25321]
]
}
]
}
]
}其中 mip_map_level 表示聚合层级（数值越大越粗），data 为该层级下的采样序列（二维整型数组，每组通常是一段窗口内的最小/最大幅度对）。示例中数组已截断,实际每层含大量采样点。字段名与结构以实际响应为准。