⌘K

Kirin V3 Image

kirin_v3_image

Kirin V3 图像生成接口, 支持文本生成图像和图像生成图像.

认证

authorization string 必填

所有 API 均使用 Bearer Token 鉴权

获取 API Key：

访问 API Key 管理页面 获取 API Key

用法：

将以下 Header 添加到请求中：

Authorization: Bearer YOUR_API_KEY

参数

model string 必填

请求使用的模型 ID.

值：kirin_v3_image

prompt string 必填

文本提示词, 可包含正向描述和负向描述

长度不能超过 2500 个字符

negative_prompt string

负向文本提示词

长度不能超过 2500 个字符

建议将负向提示词用否定描述的方式写入正向提示词中

注：图生图（即 image 字段不为空时）场景下, 不支持负向提示词

image string

参考图片

支持传入图片 Base64 编码或图片 URL（确保可访问）

图片格式要求：
图片格式支持 .jpg / .jpeg / .png
图片文件大小不能超过 10MB, 图片宽高尺寸不小于 300px, 图片宽高比要在 1:2.5 ~ 2.5:1 之间

Base64 编码要求：
若使用 Base64 方式, 请确保传递的所有图像数据参数均采用 Base64 编码格式. 在提交数据时, 请不要在 Base64 编码字符串前添加任何前缀, 例如 data:image/png;base64,. 正确的参数格式应该直接是 Base64 编码后的字符串

示例：

正确的 Base64 编码参数：

iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==

错误的 Base64 编码参数（包含 data: 前缀）：

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

请仅提供 Base64 编码的字符串部分, 以便系统能够正确处理和解析您的数据

element_list array

主体参考列表

基于主体库中主体的 ID 配置

创建主体请参考：kirin_custom_elements

数量要求：
参考主体数量和参考图片数量之和不得超过 10

格式用 key:value 承载：

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

element_id integer

主体库中主体的 ID

resolution string

生成图片的清晰度

选项: 1k, 2k

默认值: 1k

n integer

生成图片数量

默认值: 1

范围: 1 - 9

aspect_ratio string

生成图片的画面纵横比（宽:高）

选项: 16:9, 9:16, 1:1, 4:3, 3:4, 3:2, 2:3, 21:9

默认值: 16:9

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

资源类型, 如 image

url string

生成内容的 URL

jobId string

远程任务 ID

usage object

使用统计. 仅在状态为 completed 时出现.

cost string

总费用 (美元)

discount number

折扣金额

metadata object

元数据信息

错误码

错误码描述
006001094任务资源不足
006001095任务响应错误
006001099任务创建错误