重要 本文档仅适用于“中国内地(北京)”地域,且必须使用该地域的API Key。
服务开通
-
前往阿里云百炼控制台,搜索 PixVerse,找到 PixVerse 模型卡片,单击立即开通;
-
在弹窗内确认开通及授权。
适用范围
为确保调用成功,请务必保证模型、Endpoint URL 和 API Key 均属于同一地域。跨地域调用将会失败。
HTTP调用
由于参考生视频任务耗时较长(通常为1-5分钟),API采用异步调用。整个流程包含 "创建任务 -> 轮询获取" 两个核心步骤,具体如下:
步骤1:创建任务获取任务ID
北京地域:POST https://dashscope.aliyuncs.com/api/v1/services/aigc/video-generation/video-synthesis
请求参数
|
参考生视频
通过 media 传入参考图像,设置 size 和 duration 控制视频分辨率和时长。 curl --location 'https://dashscope.aliyuncs.com/api/v1/services/aigc/video-generation/video-synthesis' \
-H 'X-DashScope-Async: enable' \
-H "Authorization: Bearer $DASHSCOPE_API_KEY" \
-H 'Content-Type: application/json' \
-d '{
"model": "pixverse/pixverse-c1-r2v",
"input": {
"media": [
{
"type": "image_url",
"url": "https://help-static-aliyun-doc.aliyuncs.com/file-manage-files/zh-CN/20260320/knsple/wan-r2v-role-frame.jpg"
},
{
"type": "image_url",
"url": "https://help-static-aliyun-doc.aliyuncs.com/file-manage-files/zh-CN/20260129/qpzxps/wan-r2v-object4.png"
},
{
"type": "image_url",
"url": "https://help-static-aliyun-doc.aliyuncs.com/file-manage-files/zh-CN/20260129/wfjikw/wan-r2v-backgroud5.png"
}
],
"prompt": "男人坐在靠窗的椅子上,手持吉他,在咖啡厅旁演奏一首舒缓的美国乡村民谣"
},
"parameters": {
"size": "1280*720",
"duration": 5,
"audio": false,
"watermark": true
}
}'
参考生视频(使用ref_name)
在 media 传入参考图像,并传入ref_name用于设置参考图像的主体名称。 curl --location 'https://dashscope.aliyuncs.com/api/v1/services/aigc/video-generation/video-synthesis' \
-H 'X-DashScope-Async: enable' \
-H "Authorization: Bearer $DASHSCOPE_API_KEY" \
-H 'Content-Type: application/json' \
-d '{
"model": "pixverse/pixverse-c1-r2v",
"input": {
"media": [
{
"type": "image_url",
"url": "https://help-static-aliyun-doc.aliyuncs.com/file-manage-files/zh-CN/20260320/knsple/wan-r2v-role-frame.jpg",
"ref_name": "男人"
},
{
"type": "image_url",
"url": "https://help-static-aliyun-doc.aliyuncs.com/file-manage-files/zh-CN/20260129/qpzxps/wan-r2v-object4.png",
"ref_name": "吉他"
},
{
"type": "image_url",
"url": "https://help-static-aliyun-doc.aliyuncs.com/file-manage-files/zh-CN/20260129/wfjikw/wan-r2v-backgroud5.png",
"ref_name": "咖啡厅"
}
],
"prompt": "@男人 坐在靠窗的椅子上,手持@吉他 ,在@咖啡厅 旁演奏一首舒缓的美国乡村民谣"
},
"parameters": {
"size": "1280*720",
"duration": 5,
"audio": false,
"watermark": true
}
}'
|
请求头(Headers)
|
|
Content-Type string (必选)
请求内容类型。此参数必须设置为application/json。
|
|
Authorization string(必选)
请求身份认证。接口使用阿里云百炼API Key进行身份认证。示例值:Bearer sk-xxxx。
|
|
X-DashScope-Async string (必选)
异步处理配置参数。HTTP请求只支持异步,必须设置为enable。
重要
缺少此请求头将报错:“current user api does not support synchronous calls”。
|
请求体(Request Body)
|
|
model string (必选)
模型名称。模型输出规格请参见模型列表。
可选值:
|
|
input object (必选)
输入的基本信息,包括参考图片和提示词。
属性
prompt string (必选)
文本提示词。用来描述生成视频中期望包含的元素和视觉特点。
支持中英文,每个汉字/字母占一个字符,字符编码为UTF-8,超过部分会自动截断。
-
pixverse/pixverse-c1-r2v:不超过5000个字符。
-
pixverse/pixverse-v6-r2v:不超过2048个字符。
-
pixverse/pixverse-v5.6-r2v:不超过2048个字符。
图片引用说明:当在 media 参数中传入参考图时,可以通过 @ref_name 在prompt中直接引用该图片。
示例值:
media array (必选)
媒体素材列表,用于指定视频生成所需的参考图像。
数组的每个元素为一个媒体对象,包含 type和 url字段。
元素属性
type string (必选)
媒体素材类型。固定值为:
素材限制:
url string (必选)
图像文件的URL地址,必须为公网可访问的URL。
-
支持 HTTP 或 HTTPS 协议。
-
示例值:https://xxx/xxx.jpg。
图像限制:
-
格式:JPG、PNG、WEBP。
-
分辨率:图像的宽度和高度均不超过10000像素。
-
文件大小:不超过20MB。
ref_name string (可选)
参考图片中主体的名称标识,用于在prompt中通过@ref_name 引用。
|
|
parameters object (必选)
视频生成参数。如设置视频分辨率、时长、是否生成音频等。
属性
size string (必选)
生成视频的分辨率,格式为宽*高的像素值。
不同分辨率档位对应的可选值见下方表格。
pixverse/pixverse-c1-r2v模型
|
分辨率档位
|
宽高比
|
size取值(宽*高)
|
|
360P
|
16:9
|
640*360
|
|
4:3
|
640*480
|
|
1:1
|
640*640
|
|
3:4
|
480*640
|
|
9:16
|
360*640
|
|
3:2
|
640*432
|
|
2:3
|
432*640
|
|
21:9
|
640*288
|
|
540P
|
16:9
|
1024*576
|
|
4:3
|
1024*768
|
|
1:1
|
1024*1024
|
|
3:4
|
768*1024
|
|
9:16
|
576*1024
|
|
3:2
|
1024*688
|
|
2:3
|
688*1024
|
|
21:9
|
1024*448
|
|
720P
|
16:9
|
1280*720
|
|
4:3
|
1108*832
|
|
1:1
|
960*960
|
|
3:4
|
832*1108
|
|
9:16
|
720*1280
|
|
3:2
|
1200*800
|
|
2:3
|
800*1200
|
|
21:9
|
1280*560
|
|
1080P
|
16:9
|
1920*1080
|
|
4:3
|
1664*1248
|
|
1:1
|
1440*1440
|
|
3:4
|
1248*1664
|
|
9:16
|
1080*1920
|
|
3:2
|
1776*1184
|
|
2:3
|
1184*1776
|
|
21:9
|
1920*832
|
pixverse/pixverse-v6-r2v模型
|
分辨率档位
|
宽高比
|
size取值(宽*高)
|
|
360P
|
16:9
|
640*360
|
|
4:3
|
640*480
|
|
1:1
|
640*640
|
|
3:4
|
480*640
|
|
9:16
|
360*640
|
|
3:2
|
640*432
|
|
2:3
|
432*640
|
|
21:9
|
640*288
|
|
540P
|
16:9
|
1024*576
|
|
4:3
|
1024*768
|
|
1:1
|
1024*1024
|
|
3:4
|
768*1024
|
|
9:16
|
576*1024
|
|
3:2
|
1024*688
|
|
2:3
|
688*1024
|
|
21:9
|
1024*448
|
|
720P
|
16:9
|
1280*720
|
|
4:3
|
1108*832
|
|
1:1
|
960*960
|
|
3:4
|
832*1108
|
|
9:16
|
720*1280
|
|
3:2
|
1200*800
|
|
2:3
|
800*1200
|
|
21:9
|
1280*560
|
|
1080P
|
16:9
|
1920*1080
|
|
4:3
|
1664*1248
|
|
1:1
|
1440*1440
|
|
3:4
|
1248*1664
|
|
9:16
|
1080*1920
|
|
3:2
|
1776*1184
|
|
2:3
|
1184*1776
|
|
21:9
|
1920*832
|
pixverse/pixverse-v5.6-r2v模型(建议升级至v6)
|
分辨率档位
|
宽高比
|
size取值(宽*高)
|
|
360P
|
16:9
|
640*360
|
|
4:3
|
640*480
|
|
1:1
|
640*640
|
|
3:4
|
480*640
|
|
9:16
|
360*640
|
|
540P
|
16:9
|
1024*576
|
|
4:3
|
1024*768
|
|
1:1
|
1024*1024
|
|
3:4
|
768*1024
|
|
9:16
|
576*1024
|
|
720P
|
16:9
|
1280*720
|
|
4:3
|
1108*830
|
|
1:1
|
960*960
|
|
3:4
|
830*1108
|
|
9:16
|
720*1280
|
|
1080P
|
16:9
|
1920*1080
|
|
4:3
|
1662*1246
|
|
1:1
|
1440*1440
|
|
3:4
|
1246*1662
|
|
9:16
|
1080*1920
|
示例值:1280*720。
duration integer (必选)
生成视频的时长,单位为秒。
可选值:
-
pixverse/pixverse-c1-r2v:取值范围为[1, 15]之间的整数。
-
pixverse/pixverse-v6-r2v:取值范围为[1, 15]之间的整数。
-
pixverse/pixverse-v5.6-r2v:
示例值:5。
audio boolean (可选)
是否生成有声视频。开启后模型将根据视频内容自动生成匹配的背景音乐或音效。
-
false:默认值,输出无声视频。
-
true:输出有声视频。
示例值:false。
watermark boolean (可选)
是否添加水印标识,水印位于视频右下角,文案固定为“AI生成”。
-
false:默认值,不添加水印。
-
true:添加水印。
示例值:false。
seed integer (可选)
随机数种子,取值范围为[0, 2147483647]。
未指定时,系统自动生成随机种子。若需提升生成结果的可复现性,建议固定seed值。
请注意,由于模型生成具有概率性,即使使用相同 seed,也不能保证每次生成结果完全一致。
|
响应参数
|
成功响应
请保存 task_id,用于查询任务状态与结果。 {
"output": {
"task_status": "PENDING",
"task_id": "0385dc79-5ff8-4d82-bcb6-xxxxxx"
},
"request_id": "4909100c-7b5a-9f92-bfe5-xxxxxx"
}
异常响应
创建任务失败,请参见错误码进行解决。 {
"code": "InvalidApiKey",
"message": "No API-key provided.",
"request_id": "7438d53d-6eb8-4596-8835-xxxxxx"
}
|
|
output object
任务输出信息。
属性
task_id string
任务ID。查询有效期24小时。
task_status string
任务状态。
枚举值
-
PENDING:任务排队中
-
RUNNING:任务处理中
-
SUCCEEDED:任务执行成功
-
FAILED:任务执行失败
-
CANCELED:任务已取消
-
UNKNOWN:任务不存在或状态未知
|
|
request_id string
请求唯一标识。可用于请求明细溯源和问题排查。
|
|
code string
请求失败的错误码。请求成功时不会返回此参数,详情请参见错误码。
|
|
|
message string
请求失败的详细信息。请求成功时不会返回此参数,详情请参见错误码。
|
|
步骤2:根据任务ID查询结果
北京地域:GET https://dashscope.aliyuncs.com/api/v1/tasks/{task_id}
说明
-
轮询建议:视频生成过程约需数分钟,建议采用轮询机制,并设置合理的查询间隔(如 15 秒)来获取结果。
-
任务状态流转:PENDING(排队中)→ RUNNING(处理中)→ SUCCEEDED(成功)/ FAILED(失败)。
-
task_id 有效期:24小时,超时后将无法查询结果,接口将返回任务状态为UNKNOWN。
-
RPS 限制:查询接口默认RPS为20。如需更高频查询或事件通知,建议配置异步任务回调。
-
更多操作:如需批量查询、取消任务等操作,请参见管理异步任务。
请求参数
|
查询任务结果
将{task_id}完整替换为上一步接口返回的task_id的值。task_id查询有效期为24小时。
curl -X GET https://dashscope.aliyuncs.com/api/v1/tasks/{task_id} \
--header "Authorization: Bearer $DASHSCOPE_API_KEY"
|
请求头(Headers)
|
|
Authorization string(必选)
请求身份认证。接口使用阿里云百炼API Key进行身份认证。示例值:Bearer sk-xxxx。
|
URL路径参数(Path parameters)
|
|
|
响应参数
|
任务执行成功
{
"request_id": "35137489-2862-96cb-b6f2-xxxxxx",
"output": {
"task_id": "1469cfc3-3004-4d9e-ab10-xxxxxx",
"task_status": "SUCCEEDED",
"submit_time": "2026-03-10 15:03:25.848",
"scheduled_time": "2026-03-10 15:03:25.884",
"end_time": "2026-03-10 15:04:05.882",
"orig_prompt": "男人坐在靠窗的椅子上,手持吉他,在咖啡厅旁演奏一首舒缓的美国乡村民谣",
"video_url": "https://media.pixverseai.cn/xxxx.mp4"
},
"usage": {
"duration": 5,
"size": "1280*720",
"fps": 24,
"video_count": 1,
"audio": false,
"SR": "720"
}
}
任务执行失败
若任务执行失败,task_status将置为 FAILED,并提供错误码和信息。请参见错误码进行解决。
{
"request_id": "e5d70b02-ebd3-98ce-9fe8-759d7d7b107d",
"output": {
"task_id": "86ecf553-d340-4e21-af6e-a0c6a421c010",
"task_status": "FAILED",
"code": "InvalidParameter",
"message": "The size is not match xxxxxx"
}
}
任务查询过期
task_id查询有效期为 24 小时,超时后将无法查询,返回以下报错信息。 {
"request_id": "a4de7c32-7057-9f82-8581-xxxxxx",
"output": {
"task_id": "502a00b1-19d9-4839-a82f-xxxxxx",
"task_status": "UNKNOWN"
}
}
|
|
output object
任务输出信息。
属性
task_id string
任务ID。查询有效期24小时。
task_status string
任务状态。
枚举值
-
PENDING:任务排队中
-
RUNNING:任务处理中
-
SUCCEEDED:任务执行成功
-
FAILED:任务执行失败
-
CANCELED:任务已取消
-
UNKNOWN:任务不存在或状态未知
轮询过程中的状态流转:
-
PENDING(排队中) → RUNNING(处理中)→ SUCCEEDED(成功)/ FAILED(失败)。
-
初次查询状态通常为 PENDING(排队中)或 RUNNING(处理中)。
-
当状态变为 SUCCEEDED 时,响应中将包含生成的视频URL。
-
若状态为 FAILED,请检查错误信息并重试。
-
若状态为 CANCELED,表示任务已取消,如需继续请重新提交任务。
-
若状态为 UNKNOWN,表示任务不存在或状态未知,可能在 task_id 不存在或超过 24 小时有效期后出现。
submit_time string
任务提交时间。格式为 YYYY-MM-DD HH:mm:ss.SSS。
scheduled_time string
任务执行时间。格式为 YYYY-MM-DD HH:mm:ss.SSS。
end_time string
任务完成时间。格式为 YYYY-MM-DD HH:mm:ss.SSS。
video_url string
视频URL。仅在 task_status 为 SUCCEEDED 时返回。
视频格式为MP4(H.264 编码)。视频链接暂无过期时间,但不建议将其作为长期存储依赖,请及时下载。
orig_prompt string
原始输入的prompt,对应请求参数prompt。
code string
请求失败的错误码。请求成功时不会返回此参数,详情请参见错误码。
message string
请求失败的详细信息。请求成功时不会返回此参数,详情请参见错误码。
|
|
usage object
输出信息统计。只对成功的结果计数。
属性
duration integer
生成视频的总视频时长,用于计费。
audio boolean
生成视频是否为有声视频。
video_count integer
生成视频的数量。固定为1。
|
|
|
request_id string
请求唯一标识。可用于请求明细溯源和问题排查。
|
|
错误码
如果模型调用失败并返回报错信息,请参见错误码进行解决。
常见问题
Q: prompt 效果不理想时,如何优化?
A: 可尝试使用 @ref_name 作为替代方案。
Q:如何使用ref_name?
A:ref_name 用于建立参考图与提示词的绑定关系。在 media数组中为图片设置 ref_name 后,prompt 中可通过 @ref_name 语法引用对应的参考图主体。