跳转到主要内容
POST
/
api
/
v1
/
mp4
/
generate
创建音乐视频
curl --request POST \
  --url https://api.api.box/api/v1/mp4/generate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "taskId": "taskId_774b9aa0422f",
  "audioId": "e231****-****-****-****-****8cadc7dc",
  "callBackUrl": "https://api.example.com/callback",
  "author": "Suno Artist",
  "domainName": "music.example.com"
}
'
{
  "code": 200,
  "msg": "success",
  "data": {
    "taskId": "taskId_774b9aa0422f"
  }
}

​
用法指南

  • 此接口为您的音乐曲目创建MP4视频格式的可视化表示。
  • 需要同时提供 taskId 和 audioId 来识别具体曲目。
  • 可选的 author 和 domainName 参数可用于添加品牌信息。

​
开发者说明

  1. 生成的视频文件将保留15天。
  2. 视频包含与音乐同步的视觉效果。
  3. 此功能非常适合社交媒体分享、音乐推广或创建视觉内容。
  4. 视频保持与原始音轨相同的音频质量。

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
​
taskId
string
required

音乐生成任务的任务ID。

  • 必填。用于标识包含待转换为视频的音频的任务。
  • 需要同时提供 taskId 和 audioId 以识别确切的音轨。
Example:

"taskId_774b9aa0422f"

​
audioId
string
required

要转换为视频的具体音轨ID。

  • 必填。用于标识任务中要转换的具体音轨。
  • 需要同时提供 taskId 和 audioId 以识别确切的音轨。
Example:

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

​
callBackUrl
string<uri>
required

接收视频生成完成通知的URL。

  • 必填。
  • 回调将包含生成的MP4视频的单个可下载URL。

详细的回调格式和实现指南，请参见 音乐视频生成回调

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

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

​
author
string

显示在视频上的艺术家或创作者名称。

  • 可选。
  • 将在视频中显著展示，通常在开头。
  • 最长50个字符。
Maximum string length: 50
Example:

"Suno Artist"

​
domainName
string

作为水印显示的网站或品牌。

  • 可选。
  • 将作为微妙的水印出现在视频底部。
  • 最长50个字符。
Maximum string length: 50
Example:

"music.example.com"

Response

请求成功

​
code
enum<integer>

状态码

  • ✅ 200 - 请求成功
  • ⚠️ 400 - 无效参数
  • ⚠️ 401 - 未授权访问
  • ⚠️ 404 - 无效的请求方法或路径
  • ⚠️ 405 - 超出速率限制
  • ⚠️ 409 - 冲突 - Mp4 记录已存在
  • ⚠️ 413 - 主题或提示词过长
  • ⚠️ 429 - 积分不足
  • ⚠️ 430 - 您的调用频率过高，请稍后重试
  • ⚠️ 455 - 系统维护中
  • ❌ 500 - 服务器错误
可用选项:
200,
400,
401,
404,
405,
409,
413,
429,
430,
455,
500
​
msg
string

当 code != 200 时，展示错误信息

Example:

"success"

​
data
object