认证
authorization string 必填
所有 API 均使用 Bearer Token 鉴权
获取 API Key:
访问 API Key 管理页面 获取 API Key
用法:
将以下 Header 添加到请求中:
Authorization: Bearer YOUR_API_KEY
参数
model string 必填
请求使用的模型 ID.
值:kirin_v3_omni_image
prompt string 必填
文本提示词, 可包含正向描述和负向描述,可将提示词模板化来满足不同的图像生成需求,长度不能超过 2500 个字符
Image O3 模型可通过 Prompt 与图片等内容实现多种能力, 通过 <<<>>> 的格式来指定某个图片, 如:<<<image_1>>>
image_list array
参考图列表
支持传入图片 Base64 编码或图片 URL(确保可访问)
图片要求:
图片格式支持 .jpg / .jpeg / .png
图片文件大小不能超过 10MB, 图片宽高尺寸不小于 300px, 图片宽高比要在 1:2.5 ~ 2.5:1 之间
数量要求:
参考主体数量和参考图片数量之和不得超过 10
image 参数值不得为空
格式用 key:value 承载:
"image_list": [
{
"image": "image_url"
},
{
"image": "image_url"
}
]
image
string必填图片 URL 或 Base64 数据
element_list array
主体参考列表
基于主体库中主体的 ID 配置
创建主体请参考:kirin_custom_elements
数量要求:
参考主体数量和参考图片数量之和不得超过 10
格式用 key:value 承载:
"element_list": [
{
"element_id": long
}
]
element_id
integer主体库中主体的 ID
resolution string
生成图片的清晰度
选项: 1k, 2k, 4k
默认值: 1k
result_type string
生成结果单图/组图切换开关
选项: single, series
默认值: single
n integer
生成图片数量
取值范围 1 到 9
当 result_type 值为 series 时, 当前参数无效
默认值: 1
范围: 1 - 9
series_amount integer
生成组图的图片数量
当 result_type 值为 single 时, 当前参数无效
默认值: 4
范围: 2 - 9
aspect_ratio string
生成图片的画面纵横比(宽:高)
当参考原图横纵比生成新图时, 当前参数无效
选项: 16:9, 9:16, 1:1, 4:3, 3:4, 3:2, 2:3, 21:9, auto
默认值: auto
watermark_info array
是否同时生成含水印的结果
通过 enabled 参数定义
暂不支持自定义水印
格式用 key:value 承载:
"watermark_info": {
"enabled": boolean
}
enabled
boolean
true为生成,false为不生成
callback_url string
本次任务结果回调通知地址, 如果配置, 服务端会在任务状态发生变更时主动通知
external_task_id string
自定义任务 ID
用户自定义任务 ID, 传入不会覆盖系统生成的任务 ID, 但支持通过该 ID 进行任务查询
请注意, 单用户下需要保证唯一性
轮询
由于图像生成需要时间, 您需要在创建任务后轮询任务状态
初始响应返回任务 ID 和初始状态. 实际的生成结果必须通过轮询任务状态端点来获取
响应格式
error object
错误信息. 仅在状态为 failed 时出现.
code
string错误码
error_message
string详细错误信息
output array
生成结果. 仅在状态为 completed 时出现.
content
array生成内容列表
type
string资源类型, 如
imageurl
string生成内容的 URL
jobId
string远程任务 ID
usage object
使用统计. 仅在状态为 completed 时出现.
cost
string总费用 (美元)
discount
number折扣金额
metadata object
元数据信息
错误码
| 错误码 | 描述 |
|---|---|
| 006001094 | 任务资源不足 |
| 006001095 | 任务响应错误 |
| 006001099 | 任务创建错误 |