ideogram/ideogram-v3 的 API 参考,由 Comfy Router 提供,来源于 Ideogram。
快速开始
在你的 Comfy 工作区中创建一个密钥,并将其导出为COMFY_API_KEY。Python 和 TypeScript 代码片段使用 Comfy SDK(pip install comfy-sdk、npm install @comfyorg/sdk);cURL 代码片段则是通过原始 HTTP 执行的同一调用。
模型 ID: ideogram/ideogram-v3
端点: POST https://api.comfy.org/v2/models/ideogram/ideogram-v3
- Wait for the result
- Queue and collect later
Schema
输入
string
宽高比,格式为 WxH
object
object[]
显式指定的颜色,可带可选权重
string
十六进制颜色代码
number
该颜色的可选权重(0-1)范围:
0 到 1string
调色板的名称
string
是否启用 magic prompt 增强可选值:
AUTO、ON、OFFstring
用于指定生成时应避免出现内容的文本提示词
integer
要生成的图像数量范围:
1 到 …string
必填
用于图像生成的文本提示词
string
默认值:"\"DEFAULT\""
必填
渲染速度设置,用于控制生成速度与质量之间的权衡可选值:
DEFAULT、TURBO、QUALITYstring
图像分辨率,格式为 WxH
integer
用于可复现生成的种子值
string[]
十六进制格式的风格代码数组
string
默认值:"\"GENERAL\""
可选值:
AUTO、GENERAL、REALISTIC、DESIGN、FICTIONGET /v2/models/ideogram/ideogram-v3/openapi.json 提供的 schema 生成,该文档与 Router 在请求抵达提供商之前用于校验调用的文档相同。
输出
string (date-time)
生成创建时的时间戳。格式:
date-timeobject[]
已生成图像的信息数组。
boolean
表示该图像是否被视为安全。
string
用于生成此图像的提示词。
string
已生成图像的分辨率(例如 ‘1024x1024’)。
integer
此次生成所使用的种子值。
string
生成所使用的风格类型(例如 ‘REALISTIC’、‘ANIME’)。
string
已生成图像的 URL。
示例
输入
输出
发布前须知
SDK 会生成Idempotency-Key 并在自动重试中复用它。手动重试时,请复用原始 key。Router 最长可保持连接 10 分钟。
请求失败时,Router 会发送 X-Comfy-Error-Type 响应头说明原因。422 表示 Router 在调用提供商之前就拒绝了输入。生成的资源请及时下载,因为结果链接会过期。
请求头
身份验证、幂等性、请求 ID、错误分类、重试节奏、消费限额。
使用 Router API
模型发现、校验错误、重试与计费。
限制
Router 目前不支持的功能,以及替代方案。