跳转到主要内容
POST
  1. 提交后会返回 task_id。如果提供了 callback_url,当任务状态变为 finished 或 failed 时,系统会向 callback_url 发送 POST 请求。
  2. 无论是否提供 callback_url,都可以通过统一的查询音乐详情接口获取结果。

使用指南

  • 此接口根据音轨生成可视化音乐视频
  • 生成带有音频可视化效果和可选品牌标识的 MP4 视频
  • 适用于社交媒体内容、宣传素材或音乐分享

参数详情

  • task_id(必填):已完成的音乐生成任务(生成音乐或延长音乐)的任务 ID
  • audio_id(必填):回调数据中具体音轨的标识

开发者说明

  • 每条音轨只能生成一个音乐视频
  • 如果视频已存在,API 返回错误码 409
  • 回调中包含生成的 MP4 视频的下载 URL
  • 视频生成可能比音频处理任务耗时更长

可选参数

  • author (string):显示在视频封面上的艺人或创作者名称。最多 50 个字符。
  • domain_name (string):显示在视频底部的网站或品牌水印。最多 50 个字符。

授权

Authorization
string
header
必填

所有 API 接口都需要 Bearer Token 认证。

创建 API Key:登录 PoYo,进入 仪表盘 → API 密钥(poyo.ai/zh/dashboard/api-key),点击创建 Key。

在请求头中添加:

请求体

application/json
model
enum<string>
必填

API 模型标识符。

本接口必须为 create-music-video。

可用选项:
create-music-video
示例:

"create-music-video"

callback_url
string<uri>
必填

用于接收结果通知的 Webhook 回调 URL。

该地址会收到 POST 请求,内容包含音乐视频生成的完成状态和下载 URL。

示例:

"https://your-domain.com/callback"

input
object
必填

音乐视频创建的输入参数

响应

任务提交成功

code
enum<integer>
必填

业务状态码。200 表示成功,其他值都表示请求失败。请务必检查这个字段:部分参数校验错误会以 HTTP 200 返回,响应体里的 code 为 400。

  • 200:成功
  • 400:请求参数无效
  • 401:API Key 缺失或无效
  • 402:积分不足
  • 403:没有权限
  • 404:资源不存在
  • 408:请求超时
  • 429:请求频率超限
  • 500:服务器内部错误
  • 502:上游服务错误
  • 503:服务暂不可用

详见错误码。

可用选项:
200,
400,
401,
402,
403,
404,
408,
429,
500,
502,
503
示例:

200

data
object
必填