文生视频 - UniAPI API Doc

请求参数

Authorization

在 Header 添加参数

Authorization

，其值为在 Bearer 之后拼接 Token

示例：

Authorization: Bearer ********************

Body 参数application/json

model_name

string

必需

模型名称 kling-v1, kling-v1-5, kling-v2

prompt

string

必需

正向文本提示词

不能超过2500个字符

negative_prompt

string

可选

负向文本提示词

不能超过2500个字符
注：图生图（即image字段不为空时）场景下，不支持负向提示词

cfg_scale

number

可选

生成视频的自由度；值越大，模型自由度越小，与用户输入的提示词相关性越强
取值范围：[0, 1]

mode

string

可选

生成视频的模式

枚举值：std，pro
其中std：标准模式（标准），基础模式，性价比高
其中pro：专家模式（高品质），高表现模式，生成视频质量更佳
不同模型版本、视频模式支持范围不同，详见当前文档3-0能力地图

camera_control

object

可选

控制摄像机运动的协议（如未指定，模型将根据输入的文本/图片进行智能匹配）

不同模型版本、视频模式支持范围不同，详见当前文档3-0能力地图

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

object

可选

包含六个字段，用于指定摄像机在不同方向上的运动或变化

当运镜类型指定simple时必填，指定其他类型时不填
以下参数6选1，即只能有一个参数不为0，其余参数为0

aspect_ratio

string

可选

生成视频的画面纵横比（宽:高）
枚举值：16:9, 9:16, 1:1

duration

string

必需

生成视频时长，单位s
枚举值：5，10

callback_url

string

可选

本次任务结果回调通知地址，如果配置，服务端会在任务状态发生变更时主动通知

具体通知的消息schema见“Callback协议”

示例

{
    "model_name": "string",
    "prompt": "string",
    "negative_prompt": "string",
    "cfg_scale": 0,
    "mode": "string",
    "camera_control": {
        "type": "string",
        "config": {
            "horizontal": 0,
            "vertical": 0,
            "pan": 0,
            "tilt": 0,
            "roll": 0,
            "zoom": 0
        }
    },
    "aspect_ratio": "string",
    "duration": "string",
    "callback_url": "string"
}

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://api.uniapi.io/kling/v1/videos/text2video' \
--header 'Content-Type: application/json' \
--data-raw '{
    "model_name": "string",
    "prompt": "string",
    "negative_prompt": "string",
    "cfg_scale": 0,
    "mode": "string",
    "camera_control": {
        "type": "string",
        "config": {
            "horizontal": 0,
            "vertical": 0,
            "pan": 0,
            "tilt": 0,
            "roll": 0,
            "zoom": 0
        }
    },
    "aspect_ratio": "string",
    "duration": "string",
    "callback_url": "string"
}'

返回响应

🟢200成功

application/json

Body

code

integer

必需

错误码；具体定义见错误码

message

string

错误信息

必需

request_id

string

必需

请求ID，系统生成，用于跟踪请求、排查问题

data

object

必需

task_id

string

任务ID，系统生成

必需

task_info

object

必需

task_status

string

必需

任务状态，枚举值：submitted（已提交）、processing（处理中）、succeed（成功）、failed（失败）

created_at

integer

必需

任务创建时间，Unix时间戳、单位ms

updated_at

integer

必需

任务更新时间，Unix时间戳、单位ms

示例

{
  "code": 0, //错误码；具体定义见错误码
  "message": "string", //错误信息
  "request_id": "string", //请求ID，系统生成，用于跟踪请求、排查问题
  "data": {
    "task_id": "string", //任务ID，系统生成
    "task_info": {
      //任务创建时的参数信息
      "external_task_id": "string" //客户自定义任务ID
    },
    "task_status": "string", //任务状态，枚举值：submitted（已提交）、processing（处理中）、succeed（成功）、failed（失败）
    "created_at": 1722769557708, //任务创建时间，Unix时间戳、单位ms
    "updated_at": 1722769557708 //任务更新时间，Unix时间戳、单位ms
  }
}