Kirin V1.5 - Image to Video

API Notes

kirin_v1_5_i2v only supports first and last frame or only last frame (image + image_tail or image_tail only) when mode is pro

kirin_v1_5_i2v only supports motion brush (dynamic_masks/static_mask) when mode is pro and duration is 5 seconds

kirin_v1_5_i2v only supports camera control (camera_control, simple only) when mode is pro and duration is 5 seconds

Authentication

authorization `string` required

All APIs require authentication via Bearer Token.

Get API Key:

Visit API Key Management Page to get your API Key.

Usage:

Add to request header:

Authorization: Bearer YOUR_API_KEY

Parameters

model `string` required

Model ID to use for the request

Options: kirin_v1_5_i2v

data `object` required

Data parameter object

image string

Reference image

Supports Base64 encoded image or image URL (ensure accessible)

Note: If using Base64, ensure all image data parameters use Base64 encoding format. Do not add any prefix such as data:image/png;base64, before the Base64 string. The correct format should be the Base64 encoded string directly.

Image requirements:
Format: .jpg, .jpeg, .png
Size: Less than 10MB
Dimensions: Width and height at least 300px, aspect ratio between 1:2.5 and 2.5:1

Either image or image_tail must be provided, both cannot be empty

image + image_tail parameters, dynamic_masks/static_mask parameters, and camera_control parameters are mutually exclusive

image_tail string

Reference image - tail frame control

Supports Base64 encoded image or image URL (ensure accessible)

Note: If using Base64, ensure all image data parameters use Base64 encoding format. Do not add any prefix such as data:image/png;base64, before the Base64 string. The correct format should be the Base64 encoded string directly.

Image requirements:
Format: .jpg, .jpeg, .png
Size: Less than 10MB
Dimensions: Width and height at least 300px

Either image or image_tail must be provided, both cannot be empty

image + image_tail parameters, dynamic_masks/static_mask parameters, and camera_control parameters are mutually exclusive

prompt string

Video generation prompt, maximum 2500 characters

duration string

Video duration

Options: 5, 10

Default: 5

cfg_scale number

Generation freedom level. Higher values mean less model freedom and stronger correlation with user prompt

Range: 0 - 1

Default: 0.5

seed integer

Random seed

negative_prompt string

Negative text prompt, maximum 2500 characters

mode string

Video generation mode

std: Standard mode, basic mode with high cost-effectiveness
pro: Expert mode (high quality), high performance mode with better video quality

Options: std, pro

Default: std

static_mask string

Static brush mask area (mask image painted by user through motion brush)

“Motion brush” capability includes two types: “dynamic brush dynamic_masks” and “static brush static_mask”

Supports Base64 encoded image or image URL (ensure accessible, format requirements same as image field)

Image format supports .jpg, .jpeg, .png

Image aspect ratio must match the input image (i.e., image field), otherwise the task will fail

static_mask and dynamic_masks.mask must have the same resolution, otherwise the task will fail

dynamic_masks array

Dynamic brush configuration list

Can configure multiple groups (up to 6 groups), each group contains “mask area” and “trajectories” sequence

mask string

Dynamic brush mask area (mask image painted by user through motion brush)

Supports Base64 encoded image or image URL (ensure accessible, format requirements same as image field)

Image format supports .jpg, .jpeg, .png

Image aspect ratio must match the input image (i.e., image field), otherwise the task will fail

static_mask and dynamic_masks.mask must have the same resolution, otherwise the task will fail

trajectories array

Motion trajectory coordinate sequence

For generating 5s video, trajectory length cannot exceed 77, i.e., coordinate count range: [2, 77]

Trajectory coordinate system uses the bottom-left corner of the image as the origin

Note 1: More coordinate points provide more accurate trajectory depiction. With only 2 trajectory points, it will be a straight line connecting them

Note 2: Trajectory direction follows the input order. The first coordinate is the starting point, connecting subsequent coordinates to form the motion trajectory

x integer

Trajectory point x-coordinate (pixel coordinate with image bottom-left as origin)

y integer

Trajectory point y-coordinate (pixel coordinate with image bottom-left as origin)

camera_control object

Protocol for controlling camera movement (if not specified, model will intelligently match based on input text/image)

image + image_tail parameters, dynamic_masks/static_mask parameters, and camera_control parameters are mutually exclusive

type string

Predefined camera movement type

Options: simple

simple: Simple camera movement, choose one of six in “config”

config object

Contains six fields for specifying camera movement or changes in different directions

Required when camera movement type is specified as simple

Choose 1 of the 6 parameters below, i.e., only one parameter can be non-zero, others must be 0

horizontal number

Horizontal movement, controls camera movement in horizontal direction (translation along x-axis)

Range: [-10, 10]

Negative values indicate leftward translation, positive values indicate rightward translation

vertical number

Vertical movement, controls camera movement in vertical direction (translation along y-axis)

Range: [-10, 10]

Negative values indicate downward translation, positive values indicate upward translation

pan number

Horizontal pan, controls camera rotation in horizontal plane (rotation around y-axis)

Range: [-10, 10]

Negative values indicate leftward rotation around y-axis, positive values indicate rightward rotation

tilt number

Vertical tilt, controls camera rotation in vertical plane (rotation along x-axis)

Range: [-10, 10]

Negative values indicate downward rotation around x-axis, positive values indicate upward rotation

roll number

Roll movement, controls camera roll amount (rotation around z-axis)

Range: [-10, 10]

Negative values indicate counterclockwise rotation around z-axis, positive values indicate clockwise rotation

zoom number

Zoom, controls camera focal length change, affecting field of view distance

Range: [-10, 10]

Negative values indicate longer focal length and smaller field of view, positive values indicate shorter focal length and larger field of view

watermark_info string

Whether to generate results with watermark

Defined by enabled parameter, specific array format as follows:
"watermark_info": {
  "enabled": boolean // true to generate, false to not generate
}
Custom watermarks are not currently supported

callback_url string

Callback URL for task result notification. If configured, the server will actively notify when task status changes

external_task_id string

Custom task ID

User-defined task ID, will not override the system-generated task ID, but supports querying tasks through this ID

Please note, uniqueness must be ensured for a single user

Polling

Since video generation takes time, you need to poll the task status after creation

The initial response returns the task ID and initial status. The actual generation results must be obtained through polling the task status endpoint

Response Format

error `object`

Error information, only present when status is failed

code string

Error code

error_message string

Detailed error message

output `array`

Generation results, only present when status is completed

content array

List of generated content

type string

Resource type, e.g., video

url string

Generated content URL

usage `object`

Usage statistics, only present when status is completed

cost string

Total cost in USD

discount number

Discount amount

metadata `object`

Metadata information

Error Codes

Error Code	Description
00200301	Image missing
00200302	Image format invalid
00200303	Prompt length invalid
00200304	Duration invalid
00200305	Aspect ratio invalid
00200306	Authentication failed
00200398	Generation failed
00200399	Service unavailable

API Notes

Authentication

authorization string required

Parameters

model string required

data object required

image string

image_tail string

prompt string

duration string

cfg_scale number

seed integer

negative_prompt string

mode string

static_mask string

dynamic_masks array

mask string

trajectories array

x integer

y integer

camera_control object

type string

config object

horizontal number

vertical number

pan number

tilt number

roll number

zoom number

watermark_info string

callback_url string

external_task_id string

Polling

Response Format

error object

code string

error_message string

output array

content array

type string

url string

usage object

cost string

discount number

metadata object

Error Codes

authorization `string` required

model `string` required

data `object` required

image `string`

image_tail `string`

prompt `string`

duration `string`

cfg_scale `number`

seed `integer`

negative_prompt `string`

mode `string`

static_mask `string`

dynamic_masks `array`

mask `string`

trajectories `array`

x `integer`

y `integer`

camera_control `object`

type `string`

config `object`

horizontal `number`

vertical `number`

pan `number`

tilt `number`

roll `number`

zoom `number`

watermark_info `string`

callback_url `string`

external_task_id `string`

error `object`

code `string`

error_message `string`

output `array`

content `array`

type `string`

url `string`

usage `object`

cost `string`

discount `number`

metadata `object`