# 简介

### 官方文档

本文档不实时更新，完整版请查看官方文档 <https://docs.qingque.cn/d/home/eZQClW07IFEuX1csc-VejdY2M?identityId=1oEG9JKKMFv#section=h.o30jngluvb4t>

### 快速接入

我们完全对齐 可灵 官方 可灵 Docs 使用方法完全一致。

在需要使用 可灵 API的地方，将 api.klingai.com 替换为平台获取的 Base\_URL/kling 即可
所有请求体、返回均与官方一致

替换示例：
官方 : <https://api.klingai.com/v1/videos/text2video>

我们 : https://{{Base\_URL}}/kling/v1/videos/text2video

代码中调用请注意：
关于API KEY的填写，在Header的Authorization参数里，将管理后台-API KEYS里生成的API KEY填在Bearer后面，比如Bearer sk-xxxxxxx

## 更新日志

### 2024.12.9

#### 视频生成

V1.5模型，正式开放标准模式（STD）调用，支持视频生成 - 图生视频，暂不支持文生视频

支持标准模式

不支持尾帧控制

其他参数均支持

### 2024.11.15

#### 视频生成

正式开放可灵V1.5模型调用，支持视频生成 - 图生视频，暂不支持文生视频

model\_name 设置为 kling-v1-5

仅支持高品质模式

不支持尾帧控制

其他参数均支持

新增能力：视频延长

支持对V1.0模型生成的视频直接进行延长，每次增加4-5s的视频时长

包括创建任务、查询任务（单个）、查询任务（列表）接口

其他

新增“external\_task\_id”字段，您可以在创建任务时自定义任务id，查询时也可以通过该自定义id查询视频

### 2024.10.25

增加对于模型生成物（图片/视频）存储时长的说明

为保障信息安全，生成的图片/视频会在30天后被清理，辛苦大家及时转存

### 2024.9.19

#### 视频生成相关API

创建任务时，请求参数里的正向提示词（prompt）和负向提示词（negative\_prompt），字符数限制更新为：不超过2500个字符

正式支持“AI虚拟试穿”相关API（kolors-virtual-try-on）

## API 请求参数说明

### 请求头字段

| 字段名 | 值 | 描述 |
| --- | --- | --- |
| Content-Type | application/json | 数据交换格式 |
| Authorization | 鉴权信息，参考接口鉴权 | 鉴权信息，参考接口鉴权 |

### 请求体字段

| 字段名 | 类型 | 必填 | 默认值 | 描述 |
| --- | --- | --- | --- | --- |
| model\_name | string | 可选 | kling-v1 | 模型名称 ● 枚举值：kling-v1 ，kling-v1-5 |
| prompt | string | 必须 | 无 | 正向文本提示词 ● 不能超过2500个字符 |
| negative\_prompt | string | 可选 | 空 | 负向文本提示词 ● 不能超过2500个字符 |
| cfg\_scale | float | 可选 | 0.5 | 生成视频的自由度；值越大，模型自由度越小，与用户输入的提示词相关性越强 ● 取值范围：[0, 1] |
| mode | string | 可选 | std | 生成视频的模式 ● 枚举值：std，pro ● std：标准模式（标准），基础模式，性价比高 ● pro：专家模式（高品质），高表现模式，生成视频质量更佳 |
| camera\_control | object | 可选 | 空 | 控制摄像机运动的协议（如未指定，模型将根据输入的文本/图片进行智能匹配） 截止20241115：仅kling-v1模型5s&标准std的情况下支持镜头控制，其他情况不支持 |

#### camera\_control

| 字段名 | 类型 | 必填 | 默认值 | 描述 |
| --- | --- | --- | --- | --- |
| type | string | 可选 | 无 | 预定义的运镜类型 ● 枚举值："simple", "down\_back", "forward\_up", "right\_turn\_forward", "left\_turn\_forward" ● simple：简单运镜，此类型下可在"config"中六选一进行运镜 ● down\_back：镜头下压并后退 ➡️ 下移拉远，此类型下config参数无需填写 ● forward\_up：镜头前进并上仰 ➡️ 推进上移，此类型下config参数无需填写 ● right\_turn\_forward：先右旋转后前进 ➡️ 右旋推进，此类型下config参数无需填写 ● left\_turn\_forward：先左旋并前进 ➡️ 左旋推进，此类型下config参数无需填写 |

#### config

| 字段名 | 类型 | 必填 | 默认值 | 描述 |
| --- | --- | --- | --- | --- |
| horizontal | float | 可选 | 无 | 水平运镜，控制摄像机在水平方向上的移动量（沿x轴平移） ● 取值范围：[-10, 10]，负值表示向左平移，正值表示向右平移 |
| vertical | float | 可选 | 无 | 垂直运镜，控制摄像机在垂直方向上的移动量（沿y轴平移） ● 取值范围：[-10, 10]，负值表示向下平移，正值表示向上平移 |
| pan | float | 可选 | 无 | 水平摇镜，控制摄像机在水平面上的旋转量（绕y轴旋转） ● 取值范围：[-10, 10]，负值表示绕y轴向左旋转，正值表示绕y轴向右旋转 |
| tilt | float | 可选 | 无 | 垂直摇镜，控制摄像机在垂直面上的旋转量（沿x轴旋转） ● 取值范围：[-10, 10]，负值表示绕x轴向下旋转，正值表示绕x轴向上旋转 |
| roll | float | 可选 | 无 | 旋转运镜，控制摄像机的滚动量（绕z轴旋转） ● 取值范围：[-10, 10]，负值表示绕z轴逆时针旋转，正值表示绕z轴顺时针旋转 |
| zoom | float | 可选 | 无 | 变焦，控制摄像机的焦距变化，影响视野的远近 ● 取值范围：[-10, 10]，负值表示焦距变长、视野范围变小，正值表示焦距变短、视野范围变大 |

| 字段名 | 类型 | 必填 | 默认值 | 描述 |
| --- | --- | --- | --- | --- |
| aspect\_ratio | string | 可选 | 16:9 | 生成视频的画面纵横比（宽:高） ● 枚举值：16:9, 9:16, 1:1 |
| duration | string | 可选 | 5 | 生成视频时长，单位s ● 枚举值：5，10 |
| callback\_url | string | 可选 | 无 | 本次任务结果回调通知地址，如果配置，服务端会在任务状态发生变更时主动通知 ● 具体通知的消息schema见“Callback协议” |
| external\_task\_id | string | 可选 | 无 | 自定义任务ID ● 用户自定义任务ID，传入不会覆盖系统生成的任务ID，但支持通过该ID进行任务查询 ● 请注意，单用户下需要保证唯一性 |
