DataEyes · API 文档
最后更新:2026-06-26
| 环境 | Base URL |
|---|---|
| DataEyes | https://platform.dataeyes.ai/ali |
Authorization 请求头中携带 API Key,格式如下:Authorization: Bearer sk-xxxxtask_id。task_id 查询任务状态与结果。POST https://platform.dataeyes.ai/ali/api/v1/services/aigc/video-generation/video-synthesis| 参数名 | 类型 | 必选 | 说明 |
|---|---|---|---|
Content-Type | string | 是 | 固定值:application/json |
Authorization | string | 是 | API Key 认证。格式:Bearer sk-xxxx |
X-DashScope-Async | string | 是 | 异步处理标识,必须设置为 enable。缺少此请求头将返回错误:"current user api does not support synchronous calls" |
| 参数名 | 类型 | 必选 | 说明 |
|---|---|---|---|
model | string | 是 | 模型名称。可选值:happyhorse-1.1-r2v、happyhorse-1.0-r2v |
input | object | 是 | 模型输入信息,详见下表 |
parameters | object | 否 | 视频处理参数,详见下表 |
input 对象| 参数名 | 类型 | 必选 | 说明 |
|---|---|---|---|
prompt | string | 是 | 文本提示词,用于描述生成视频中期望包含的元素和视觉特点。支持任意语言输入,长度不超过 5000 个非中文字符或 2500 个中文字符,超出部分自动截断。 |
media | array | 是 | 媒体素材列表,用于指定参考图像。数组中的第 1 个 reference_image 对应 [Image 1],第 2 个对 应 [Image 2],以此类推。 |
[Image 1]、[Image 2] 标识指代 media 数组中对应位置的参考图像。使用时需指明参考图中的具体对象,例如:"[Image 1]中身着红色旗袍的女性"。media[] 元素属性| 参数名 | 类型 | 必选 | 说明 |
|---|---|---|---|
type | string | 是 | 媒体素材类型。固定值:reference_image(参考图像) |
url | string | 是 | 参考图像的 URL 或 Base64 编码数据 |
| 项目 | 要求 |
|---|---|
| 数量 | 1 ~ 9 张 |
| 格式 | JPEG、JPG、PNG、WEBP |
| 分辨率 | 短边不低于 400 像素,推荐 720P 以上清晰图。避免传入过小、模糊或压缩过度的图像 |
| 文件大小 | 不超过 20MB |
https://xxx/xxx.jpgdata:{MIME_type};base64,{base64_data}。示例:data:image/png;base64,GDU7MtCZ...| 图像格式 | MIME Type |
|---|---|
| JPEG/JPG | image/jpeg |
| PNG | image/png |
| WEBP | image/webp |
parameters 对象| 参数名 | 类型 | 必选 | 默认值 | 说明 |
|---|---|---|---|---|
resolution | string | 否 | 1080P | 视频分辨率档位。可选值:720P、1080P |
ratio | string | 否 | 16:9 | 视频宽高比。可选值:16:9、9:16、1:1、4:3、3:4、4:5、5:4、9:21、21:9 |
duration | integer | 否 | 5 | 视频时长,单位:秒。取值范围:[3, 15] 的整数 |
watermark | boolean | 否 | true | 是否添加水印(位于视频右下角,文案固定为"Happy Horse")。true:添加;false:不添加 |
seed | integer | 否 | 随机 | 随机数种子,取值范围:[0, 2147483647]。固定 seed 可提升结果可复现性,但不保证完全一致 |
{
"output": {
"task_status": "PENDING",
"task_id": "0385dc79-5ff8-4d82-bcb6-xxxxxx"
},
"request_id": "4909100c-7b5a-9f92-bfe5-xxxxxx"
}| 字段名 | 类型 | 说明 |
|---|---|---|
output.task_id | string | 任务 ID,用于后续查询。有效期 24 小时 |
output.task_status | string | 任务状态。枚举值见任务状态说明 |
request_id | string | 请求唯一标识,可用于溯源和问题排查 |
code | string | 错误码(仅在请求失败时返回) |
message | string | 错误详情(仅在请求失败时返回) |
GET https://platform.dataeyes.ai/ali/api/v1/tasks/{task_id}{task_id} 替换为步骤一返回的任务 ID。| 参数名 | 类型 | 必选 | 说明 |
|---|---|---|---|
Authorization | string | 是 | API Key 认证。格式:Bearer sk-xxxx |
PENDING → RUNNING → SUCCEEDED / FAILED。task_id 有效期为 24 小时,超时后将无法查询。{
"request_id": "35137489-2862-96cb-b6f2-xxxxxx",
"output": {
"task_id": "1469cfc3-3004-4d9e-ab10-xxxxxx",
"task_status": "SUCCEEDED",
"submit_time": "2026-04-25 15:03:25.848",
"scheduled_time": "2026-04-25 15:03:25.884",
"end_time": "2026-04-25 15:04:05.882",
"orig_prompt": "[Image 1]中身着红色旗袍的女性...",
"video_url": "https://dashscope-result.oss-cn-beijing.aliyuncs.com/xxxx.mp4"
},
"usage": {
"duration": 5,
"input_video_duration": 0,
"output_video_duration": 5,
"video_count": 1,
"SR": 720,
"ratio": "16:9"
}
}| 字段名 | 类型 | 说明 |
|---|---|---|
output.task_id | string | 任务 ID |
output.task_status | string | 任务状态。枚举值见任务状态说明 |
output.submit_time | string | 任务提交时间。格式:YYYY-MM-DD HH:mm:ss.SSS |
output.scheduled_time | string | 任务开始执行时间。格式:YYYY-MM-DD HH:mm:ss.SSS |
output.end_time | string | 任务完成时间。格式:YYYY-MM-DD HH:mm:ss.SSS |
output.video_url | string | 生成的视频下载链接。仅在 SUCCEEDED 状态返回,有效期 24 小时。视频格式:MP4(H.264 编码) |
output.orig_prompt | string | 原始输入的 prompt |
output.code | string | 错误码(仅在失败时返回) |
output.message | string | 错误详情(仅在失败时返回) |
usage.duration | integer | 总视频时长(秒),用于计费 |
usage.input_video_duration | integer | 输入视频时长(秒),参考生视频场景固定为 0 |
usage.output_video_duration | integer | 输出视频时长(秒) |
usage.video_count | integer | 输出视频数量,固定为 1 |
usage.SR | integer | 输出视频分辨率档位 |
usage.ratio | string | 输出视频宽高比 |
request_id | string | 请求唯一标识,可用于溯源和问题排查 |
| 状态值 | 说明 |
|---|---|
PENDING | 任务排队中 |
RUNNING | 任务处理中 |
SUCCEEDED | 任务执行成功 |
FAILED | 任务执行失败 |
CANCELED | 任务已取消 |
UNKNOWN | 任务不存在或状态未知(task_id 不存在或已超过 24 小时有效期) |
X-DashScope-Async: enable 为必填请求头,缺少将报错。| 错误码 | 说明 |
|---|---|
InvalidApiKey | API Key 无效或未提供 |
InvalidParameter | 请求参数不合法 |
Throttling | 请求频率超限 |
