快速入门
在你的 Comfy 工作区中创建密钥,并将其导出为COMFY_API_KEY。Python、TypeScript 和 Swift 片段使用 Comfy SDK(pip install comfy-sdk、npm install @comfyorg/sdk,以及 ComfySwiftSDK Swift 包);cURL 片段是通过原始 HTTP 发出的相同调用。
模型 ID: ideogram/ideogram-v4
端点: POST https://api.comfy.org/v2/models/ideogram/ideogram-v4
- 等待结果
- 稍后排队并收集
Schema
输入
boolean
选择开启生成后版权检测(Hive 相似度和标识检查)。
object
结构化的 V4 提示词。会禁用 Magic Prompt;直接使用该内容。text_prompt 或 json_prompt 必须且只能提供其中一个。
string
默认值:"\"DEFAULT\""
渲染速度设置,用于控制生成速度与质量之间的权衡可选值:
DEFAULT、TURBO、QUALITYstring
输出分辨率,格式为 WIDTHxHEIGHT。省略该参数则让模型自行选择宽高比。支持的 2K 取值:2048x2048、1440x2880、2880x1440、1664x2496、2496x1664、1792x2240、2240x1792、1440x2560、2560x1440、1600x2560、2560x1600、1728x2304、2304x1728、1296x3168、3168x1296、1152x2944、2944x1152、1248x3328、3328x1248、1280x3072、3072x1280。
string
自然语言提示词。会自动启用 Magic Prompt。text_prompt 或 json_prompt 必须且只能提供其中一个。
GET /v2/models/ideogram/ideogram-v4/openapi.json 处提供的 schema 生成,该文档与请求到达提供商之前用于校验调用的文档相同。
输出
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 在调用提供商之前就拒绝了输入,413 表示请求体超出了 Router 可接受的大小。已生成的资源请及时下载,因为结果 URL 会过期。
上文任何字段描述中提到的尺寸限制,都是提供商对该字段自身的限定,引自提供商的规范。Router 会对整个请求体另行设置上限,base64 编码的媒体内容也计入其中:参见请求体大小。
本页记录的是通过 Comfy Router 调用的某一个合作伙伴模型。同一个 comfy-sdk / @comfyorg/sdk 包还提供第二个客户端,用于在 Comfy Cloud 上运行完整的 ComfyUI 工作流图:Comfy(api_key=...) / new Comfy({ apiKey }),并带有 client.workflows、client.assets 和 client.jobs。请参阅 Comfy SDKs。
请求头
身份验证、幂等性、请求 ID、错误分类、重试节奏、消费限额。
使用 Router API
模型发现、验证错误、重试与计费。
限制
Router 目前不支持的功能,以及替代方案。