认证
authorization string 必填
所有 API 均使用 Bearer Token 鉴权
获取 API Key:
访问 API Key 管理页面 获取 API Key
用法:
将以下 Header 添加到请求中:
Authorization: Bearer YOUR_API_KEY
参数
model string 必填
请求使用的模型 ID.
值:kirin_video_o1
prompt string 必填
视频生成提示词, 其内容可以包含正面和负面的描述, 这些提示词可以进行模板化处理, 以满足不同的视频生成需求. 不能超过 2500 个字符
Omni 模型可通过 Prompt 与主体、图片、视频等内容实现多种能力. 通过 <<<>>> 的格式来指定某个主体、图片或视频, 如:<<<element_1>>>、<<<image_1>>>、<<<video_1>>>
image_list array
参考图片列表, 包括元素、场景、风格等的参考图片, 也可用作生成视频的首帧或尾帧
使用 type 参数定义图片是在首帧还是尾帧:first_frame 表示首帧, end_frame 表示尾帧
注意:
目前不支持仅设置尾帧, 这意味着当存在尾帧图片时, 必须同时存在首帧图片
当生成视频的首帧或尾帧时, 无法使用视频编辑功能
当图片数量超过 2 张时, 不支持设置尾帧
支持传入图片 Base64 编码或图片 URL(确保可访问)
图片要求:
格式:.jpg, .jpeg, .png
文件大小:不超过 10MB
尺寸:宽高不小于 300px
宽高比:介于 1:2.5 ~ 2.5:1 之间
数量限制:
有参考视频时:参考图片数量 + 参考主体数量 ≤ 4
无参考视频时:参考图片数量 + 参考主体数量 ≤ 7
image_url
string图片 URL 或 Base64 数据
image
string图片 URL 或 Base64 数据(兼容字段)
type
string图片类型
选项:
first_frame,end_frame
video_list array
参考视频, 通过 URL 方式获取. 可作为特征参考视频, 也可作为待编辑视频, 默认为待编辑视频;可选择性保留视频原声
通过 refer_type 参数区分参考视频类型:feature 为特征参考视频, base 为待编辑视频
参考视频为待编辑视频时, 不能定义视频首尾帧
通过 keep_original_sound 参数选择是否保留视频原声, yes 为保留, no 为不保留;当前参数对特征参考视频(feature)也生效
视频要求:
格式:仅支持 MP4, MOV
时长:3-10 秒
尺寸:介于 720px 和 2160px 之间
帧率:24-60fps, 生成视频时会输出为 24fps
至多仅支持上传 1 段视频, 视频大小不超过 200MB
video_url
string必填视频 URL 地址, 支持 MP4/MOV 格式
refer_type
string参考视频类型
选项:
feature,base默认值:
base
keep_original_sound
string是否保留视频原声
选项:
yes,no
element_list array
主体参考列表, 基于主体库中主体的 ID 配置
创建主体请参考:kirin_custom_elements
数量限制:
有参考视频时:参考图片数量 + 参考主体数量 ≤ 4
无参考视频时:参考图片数量 + 参考主体数量 ≤ 7
element_id
integer主体库中主体的 ID
mode string
视频生成模式
std:标准模式, 成本效益高
pro:专业模式, 生成的视频时长较长但视频输出质量更高
选项:std, pro
默认值:pro
aspect_ratio string
生成的视频帧的纵横比(宽度:高度)
当不使用首帧参考或视频编辑功能时, 此参数是必需的
选项:16:9, 9:16, 1:1
duration string
视频时长(秒), Omni 支持 3-10 秒
使用文生视频、首帧图生视频时, 仅支持 5 和 10 秒
使用视频编辑功能(refer_type: base)时, 输出结果与传入视频时长相同, 此时当前参数无效;此时, 按输入视频时长四舍五入取整计量计费
选项:3, 4, 5, 6, 7, 8, 9, 10
默认值:5
watermark_info array
是否同时生成含水印的结果
通过 enabled 参数定义, 具体格式如下:
"watermark_info": {
"enabled": boolean // true 为生成,false 为不生成
}
暂不支持自定义水印
callback_url string
本次任务结果回调通知地址,如果配置,服务端会在任务状态发生变更时主动通知
external_task_id string
自定义任务 ID
用户自定义任务 ID,传入不会覆盖系统生成的任务 ID,但支持通过该 ID 进行任务查询
请注意,单用户下需要保证唯一性
轮询
由于视频生成需要时间, 您需要在创建任务后轮询任务状态
初始响应返回任务 ID 和初始状态. 实际的生成结果必须通过轮询任务状态端点来获取
响应格式
error object
错误信息.仅在状态为 failed 时出现.
code
string错误码
error_message
string详细错误信息
output array
生成结果.仅在状态为 completed 时出现.
content
array生成内容列表
type
string资源类型,如
video、image
url
string生成内容的 URL
duration
number视频时长
jobId
string远程任务 ID
usage object
使用统计.仅在状态为 completed 时出现.
cost
string总费用 (美元)
discount
number折扣金额
metadata object
元数据信息
错误码
| 错误码 | 描述 |
|---|---|
| 002015001 | 提示词缺失 |
| 002015002 | 提示词超过 2500 字符限制 |
| 002015095 | 内部生成错误 |
| 002015096 | 结果解析异常 |
| 002015097 | HTTP 错误响应 |
| 002015098 | 状态检查异常 |
| 002015099 | 任务创建异常 |