Kirin Image O1

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_image_omni

---

prompt string required

Text prompt, can include positive and negative descriptions. You can template prompts to meet different image generation needs. Max 2500 characters

Use <<<image_N>>> format to reference specific images, e.g., <<<image_1>>>

---

image_list array

Reference image list

Supports Base64 encoded image or image URL (ensure accessibility)

Image requirements:
Format: .jpg, .jpeg, .png
File size: max 10MB
Dimensions: min 300px for width and height
Aspect ratio: between 1:2.5 ~ 2.5:1

The total number of reference subjects and reference images must not exceed 10. The image value must not be empty

---

resolution string

Image resolution

Options: 1k, 2k

Default: 1k

---

n integer

Number of images to generate, range 1-9

Default: 1

---

aspect_ratio string

Image aspect ratio (width:height)

When referencing original image aspect ratio for new image generation, this parameter is invalid

Options: 16:9, 9:16, 1:1, 4:3, 3:4, 3:2, 2:3, 21:9, auto

Default: auto

---

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 image 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

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
002016001	Prompt missing
002016002	Prompt exceeds 2500 character limit
002016003	Generation image quantity n must be between 1-9
002016095	Internal generation error
002016096	Result parsing error
002016097	HTTP error response
002016098	Status check error
002016099	Task creation error