Kirin V3 - Image to Video

API Tips

Image Format Requirements

image and image_tail parameters:

Supports Base64 encoded image or image URL (ensure accessibility)

Please note, if you use base64 format, ensure all image data parameters use Base64 encoding format. When submitting data, do not add any prefix before the Base64 encoded string, such as data:image/png;base64,. The correct parameter format should be directly the Base64 encoded string

Example:

Correct Base64 encoded parameter:

iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==

Incorrect Base64 encoded parameter (contains data: prefix):

data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==

Please provide only the Base64 encoded string part so that the system can correctly process and parse your data

Image requirements:
Format: .jpg, .jpeg, .png
File size: max 10MB
Dimensions: min 300px for width and height
image parameter: aspect ratio between 1:2.5 ~ 2.5:1
image_tail parameter: no aspect ratio restriction

---

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.

Value: kirin_v3_i2v

---

image string

Reference image

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

---

image_tail string

Reference image - end frame control

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

---

multi_shot boolean

Whether to generate multi-shot video

When this parameter is true, the prompt parameter is invalid

When this parameter is false, the shot_type and multi_prompt parameters are invalid

Default: false

---

shot_type string

Shot type

When multi_shot parameter is true, this parameter is required

Options: customize

---

prompt string

Video generation prompt, can include positive and negative descriptions

Max 2500 characters

When multi_shot parameter is false, this parameter cannot be empty

---

multi_prompt array

Multi-shot information, such as prompts and durations

Define shot sequence and corresponding prompts and durations via index, prompt, duration parameters:

• Supports up to 6 shots, minimum 1 shot
• Max length of each shot-related content does not exceed 512
• Duration of each shot is not greater than the total duration of the current task, and not less than 1
• Sum of durations of all shots equals the total duration of the current task

Format as key:value pairs:

"multi_prompt": [
  {
    "index": int,
    "prompt": "string",
    "duration": "5"
  },
  {
    "index": int,
    "prompt": "string",
    "duration": "5"
  }
]

When multi_shot parameter is true and shot_type parameter is customize, this parameter cannot be empty

---

negative_prompt string

Negative text prompt

It is recommended to add negative prompt information directly in the positive prompt through negative sentences

Max 2500 characters

---

element_list array

Subject reference list

Configured based on subject ID from subject library, format as key:value pairs:

To create a subject, refer to: kirin_custom_elements

"element_list": [
  {
    "element_id": long
  },
  {
    "element_id": long
  }
]

Max 3 reference subjects supported

Subjects are divided into video custom subjects (video role subjects) and image custom subjects (multi-image subjects), with different applicable scopes, please distinguish

---

sound string

Whether to generate sound when generating video

Options: on, off

Default: off

---

mode string

Video generation mode

std: Standard mode (standard), basic mode, generates 720P video, cost-effective
pro: Professional mode (high quality), high performance mode, generates 1080P video, better video quality

Options: std, pro

Default: std

---

duration string

Video duration in seconds

Options: 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15

Default: 5

---

watermark_info array

Whether to generate results with watermarks simultaneously

Defined via the enabled parameter, specific format as follows:

"watermark_info": {
  "enabled": boolean // true for generation, false for no generation
}

Custom watermarks are not currently supported

---

callback_url string

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

---

external_task_id string

Custom task ID

User-defined task ID, will not overwrite the system-generated task ID when provided, but supports task query via this ID

Please note that uniqueness must be ensured under 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, image

url string

Generated content URL

duration number

Video duration

jobId string

Remote job ID

---

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
006001094	Task resource insufficient
006001095	Task response error
006001099	Task creation error