接口提示
kirin_custom_elements 仅支持基于图片创建主体,不支持 reference_type、element_image_list、element_video_list 和 element_voice_id
认证
authorization string 必填
所有 API 均使用 Bearer Token 鉴权
获取 API Key:
访问 API Key 管理页面 获取 API Key
用法:
将以下 Header 添加到请求中:
Authorization: Bearer YOUR_API_KEY
参数
model string 必填
请求使用的模型 ID
值: kirin_custom_elements
element_name string 必填
主体名称
范围: 最多 20 个字符
element_description string 必填
主体描述
范围: 最多 100 个字符
element_frontal_image string 必填
用于定义主体主要外观的正面参考图,支持图片 URL 或 Base64 编码的图片内容。
支持格式:.jpg、.jpeg、.png
范围:文件大小不能超过 10MB;宽高尺寸不小于 300px;宽高比需在 1:2.5 到 2.5:1 之间
element_refer_list array 必填
用于补充主体其他角度或细节特征的参考图列表。必须包含 1 到 3 张图片,且每张图片都应与 element_frontal_image 有差异。
image_url
string必填参考图 URL 或 Base64 编码的图片内容。
支持格式:
.jpg、.jpeg、.png
范围:文件大小不能超过10MB;宽高尺寸不小于300px;宽高比需在1:2.5到2.5:1之间
tag_list array
为主体配置标签,一个主体可以配置多个标签。
| tag_id | 名称 |
|---|---|
| o_101 | 热梗 |
| o_102 | 人物 |
| o_103 | 动物 |
| o_104 | 道具 |
| o_105 | 服饰 |
| o_106 | 场景 |
| o_107 | 特效 |
| o_108 | 其他 |
tag_id
string必填标签 ID。
可选值:
o_101、o_102、o_103、o_104、o_105、o_106、o_107、o_108
callback_url string
回调 URL
external_task_id string
自定义任务 ID。传入后不会覆盖系统生成的任务 ID,但支持通过该 ID 进行任务查询。
注:单用户下需要保证唯一性。
轮询
由于结果生成需要时间,您需要在创建任务后轮询任务状态
初始响应只返回任务 ID 和初始状态等信息,最终生成结果需通过使用该任务 ID 轮询任务状态接口获取
轮询请求与响应示例见右侧
响应格式
output array
生成结果,仅在状态为 completed 时出现。
content
array生成内容列表
text
string主体信息 JSON 字符串,包含以下字段:
element_id:主体 ID
element_name:主体名称
element_description:主体描述
element_frontal_image:正面参考图
element_refer_list:补充参考图列表
element_refer_list[].image_url:参考图 URL
tag_list:标签列表
tag_list[].id:标签 ID
tag_list[].name:标签名称
tag_list[].description:标签描述
owned_by:主体归属用户 ID
final_unit_deduction:最终扣费额度type
string资源类型, 此接口返回
texturl
stringURL(此接口为空)