认证
authorization string 必填
所有 API 均使用 Bearer Token 鉴权
获取 API Key:
访问 API Key 管理页面 获取 API Key
用法:
将以下 Header 添加到请求中:
Authorization: Bearer YOUR_API_KEY
参数
model string 必填
请求使用的模型 ID。
值:kirin_v2_1_image
prompt string 必填
文本提示词,用于描述需要生成的图像。
长度不能超过 2500 个字符。
image string
参考图片。需要基于输入图片生成图像时传入该字段;文本生成图像时可不传。
支持传入可访问的图片 URL 或图片 Base64 编码。
图片格式要求:
图片格式支持 .jpg / .jpeg / .png。
图片文件大小不能超过 10MB,图片宽高尺寸不小于 300px,图片宽高比要在 1:2.5 到 2.5:1 之间。
Base64 编码要求:
若使用 Base64 方式,请仅传入 Base64 编码字符串本身,不要添加 data:image/png;base64, 等前缀。
negative_prompt string
负向文本提示词。
长度不能超过 2500 个字符。
图生图场景下,即 image 字段不为空时,负向提示词可能不支持。
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
callback_url string
本次任务结果回调通知地址。如果配置,服务端会在任务状态发生变更时主动通知。
external_task_id string
自定义任务 ID。传入后不会覆盖系统生成的任务 ID,但支持通过该 ID 进行任务查询。
请注意,单用户下需要保证唯一性。
轮询
图像生成是异步任务。创建任务后,需要轮询任务状态接口获取最终结果。
创建任务响应会返回任务 ID 和初始状态。生成后的图片 URL 会在任务完成后通过轮询接口返回。
响应格式
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 时返回。