# Omni-Video

**方法**: `POST`
**路径**: `/kling/v1/videos/omni-video`

本文档不实时更新，完整版请查看官方文档：<https://docs.qingque.cn/d/home/eZQCRUy_LWt70n5Wz2sTiLV6J?identityId=1oEFzU43FYK#section=h.hhdxwtuxzvyf>

【可灵视频O1模型亮点】
· 输入任何内容，支持多模态视频生成
· 多模态输入，统一创作与修改
· 解决视频一致性问题
· 强大组合，创意更多
· 可控生成时间，3-10秒自由叙事

## 请求参数

### Header 参数

```text
Authorization
string
可选
默认值:
Bearer {{YOUR_API_KEY}}
```

### Body 参数 application/json

```text
model_name
string
必需
kling-video-o1
prompt
string
必需
文本提示词，可包含正向描述和负向描述
● 可将提示词模板化来满足不同的视频生成需求
● 不能超过2500个字符
Omni模型可通过Prompt与主体、图片、视频等内容实现多种能力
能力范围详见使用手册：可灵 O1 - 视频 O1 使用指南（内测版）
通过<<<>>>的格式来指定某个主体、图片或视频，如：<<<element_1>>>、<<<image_1>>>、<<<video_1>>>
<= 5000 字符
aspect_ratio
string
必需
成视频的画面纵横比（宽:高）
● 枚举值：16:9, 9:16, 1:1
● 未使用首帧参考或视频编辑功能时，当前参数必填
image_list
array
[string]
可选
参考图列表
● 包括主体、场景、风格等参考图片，也可作为首帧或尾帧生成视频；当作为首帧或尾帧生成视频时：
○ 通过type参数来定义图片是否为首尾帧：first_frame为首帧，end_frame为尾帧
○ 暂时不支持仅尾帧，即有尾帧图时必须有首帧图
○ 首帧或首尾帧生视频时，不能使用视频编辑功能
● 用key:value承载，如下：
"image_list":[
{
"image_url":"image_url",
"type":"first_frame"
},
{
"image_url":"image_url",
"type":"end_frame"
}
]
● 支持传入图片Base64编码或图片URL（确保可访问）
● 图片格式支持.jpg / .jpeg / .png
● 图片文件大小不能超过10MB，图片宽高尺寸不小于300px，图片宽高比要在1:2.5 ~ 2.5:1之间
● 有参考视频时，参考图片数量不得超过4；无参考视频时，参考图片数量不得超过7
● 数组中超过2张图片时，不支持设置尾帧
element_list
array
[string]
可选
主体参考列表
● 基于主体库中主体的ID配置，用key:value承载，如下：
"element_list":[
{
"element_id":long
}
]
● 参考主体数量与有无参考视频、参考图片数量有关，其中：
○ 有参考视频时，参考图片数量和参考主体数量之和不得超过4；
○ 无参考视频时，参考图片数量和参考主体数量之和不得超过7
video_list
array
[string]
可选
参考视频，通过URL方式获取
● 可作为特征参考视频，也可作为待编辑视频，默认为待编辑视频；可选择性保留视频原声
○ 通过refer_type参数区分参考视频类型：feature为特征参考视频，base为待编辑视频
○ 参考视频为待编辑视频时，不能定义视频首尾帧
○ 通过keep_original_sound参数选择是否保留视频原声，yes为保留，no为不保留；当前参数对特征参考视频（feature）也生效
● 用key:value承载，如下：
"video_list":[
{
"video_url":"video_url",
"refer_type":"base",
"keep_original_sound":"yes"
}
]
● 视频格式仅支持MP4/MOV
● 仅支持时长≥3秒且≤10秒的视频
● 视频宽高尺寸需介于720px（含）和2160px（含）之间
● 视频帧率基于24fps～60fps，生成视频时会输出为24fps
● 至多仅支持上传1段视频，视频大小不超过200MB
mode
enum<string>
可选
生成视频的模式
● 枚举值：pro
● 其中pro：专家模式（高品质），高表现模式，生成视频质量更佳
不同模型版本、视频模式支持范围不同，详见当前文档3-0能力地图
枚举值:
std（高性能）
pro（高表现）
duration
enum<string>
可选
生成视频时长，单位s
● 枚举值：3，4，5，6，7，8，9，10，其中：
○ 使用文生视频、首帧图生视频、首尾帧生视频时，仅支持5和10s
○ 使用视频编辑功能（"refer_type":"base"）时，输出结果与传入视频时长相同，此时当前参数无效；此时，按输入视频时长四舍五入取整计量计费
枚举值:
5
10
callback_url
string
可选
本次任务结果回调通知地址，可选
示例
{
"model_name"
:
"string"
,
"prompt"
:
"string"
,
"aspect_ratio"
:
"string"
,
"image_list"
:
[
"string"
]
,
"element_list"
:
[
"string"
]
,
"video_list"
:
[
"string"
]
,
"mode"
:
"std（高性能）"
,
"duration"
:
"5"
,
"callback_url"
:
"string"
}
```

## 请求示例代码

### Shell

```bash
curl --location --request POST '/kling/v1/videos/omni-video' \
--header 'Authorization: Bearer {{YOUR_API_KEY}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "model_name": "string",
    "prompt": "string",
    "aspect_ratio": "string",
    "image_list": [
        "string"
    ],
    "element_list": [
        "string"
    ],
    "video_list": [
        "string"
    ],
    "mode": "std（高性能）",
    "duration": "5",
    "callback_url": "string"
}'
```

## 返回响应

### 🟢 200 成功

**内容类型**: `application/json`

#### 响应结构

```text
code
integer
必需
错误码；具体定义错误码
message
string
错误信息
必需
request_id
string
必需
请求ID，系统生成，用于跟踪请求、排查问题
data
object
必需
task_id
string
任务ID，系统生成
必需
task_status
enum<string>
必需
任务状态，枚举值：submitted（已提交）、processing（处理中）、succeed（成功）、failed（失败）
枚举值:
submitted（已提交）
processing（处理中）
succeed（成功）
failed（失败）
created_at
integer
必需
任务创建时间，Unix时间戳、单位ms
updated_at
integer
必需
任务更新时间，Unix时间戳、单位ms
```

#### 示例

```json
{
    "code": 0,
    "message": "string",
    "request_id": "string",
    "data": {
        "task_id": "string",
        "task_status": "string",
        "created_at": 0,
        "updated_at": 0
    }
}
```