API Notes
kirin_v2_1_master_i2v generates videos at 1080p resolution with 24fps frame rate.
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_v2_1_master_i2v
image string required
Reference image
Supports Base64 encoded image or image URL (ensure accessible)
Please note, if you use 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
prompt string
Positive text prompt, maximum 2500 characters
duration string
Video duration in seconds
Options: 5, 10
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
stringError code
error_message
stringDetailed error message
output array
Generation results. Only present when status is completed.
content
arrayList of generated content
type
stringResource type, e.g.,
video,imageurl
stringGenerated content URL
duration
numberVideo duration
jobId
stringRemote job ID
usage object
Usage statistics. Only present when status is completed.
cost
stringTotal cost in USD
discount
numberDiscount amount
metadata object
Metadata information
Error Codes
| Error Code | Description |
|---|---|
| 0 | No error |
| 8002009001 | Image missing |
| 8002009002 | Image format invalid |
| 8002009003 | Prompt length invalid |
| 8002009004 | Duration invalid |
| 8002009005 | Aspect ratio invalid |
| 8002009006 | JWT authentication failed |
| 8002009098 | Generation process failed |
| 8002009099 | Provider unavailable |