将 Ideogram V3 与 Comfy Router 配合使用

通过 Comfy Router 调用 ideogram/ideogram-v3：endpoint、请求结构与 Router 返回的响应。

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

[tab] 等待结果 ``python Python theme={null} from comfy_sdk import Comfy # 从环境变量中读取 COMFY_API_KEY。 # SDK 会自动创建幂等键，并在自动重试时复用它。 with Comfy() as client: result = client.models.run( "ideogram/ideogram-v3", { "prompt": "A beautiful mountain landscape", "rendering_speed": "TURBO", }, ) print(result) ` `typescript TypeScript theme={null} import { comfy } from "@comfyorg/sdk"; // 从环境变量中读取 COMFY_API_KEY。 // SDK 会自动创建幂等键，并在自动重试时复用它。 const { data } = await comfy.models.run("ideogram/ideogram-v3", { prompt: "A beautiful mountain landscape", rendering_speed: "TURBO", }); console.log(data); ` `bash cURL theme={null} curl https://api.comfy.org/v2/models/ideogram/ideogram-v3 \ -H "X-API-Key: $COMFY_API_KEY" \ -H "Idempotency-Key: $(uuidgen)" \ -H "Content-Type: application/json" \ -d "{\"prompt\": \"A beautiful mountain landscape\", \"rendering_speed\": \"TURBO\"}" ``

[tab] 入队并稍后收集相同的请求体，发送到 POST https://api.comfy.org/v2/models/ideogram/ideogram-v3/requests。运行一旦被接纳，Router 就会返回 201 和一个 request_id；结果就绪后即可收集，可以从当前进程或另一个进程收集。排队投递详细介绍了状态、取消和收集的流程。 ``python Python theme={null} import asyncio from comfy_sdk import AsyncComfy # 从环境变量中读取 COMFY_API_KEY。 # 每次 submit() 调用都会生成自己的 Idempotency-Key，并在自动重试时复用它。 async def main(): async with AsyncComfy() as client: handle = await client.models.submit( "ideogram/ideogram-v3", { "prompt": "A beautiful mountain landscape", "rendering_speed": "TURBO", }, ) print("request_id:", handle.request_id) # 结合模型 ID，这就是另一个进程所需的全部信息 # 轮询直到请求完成，等待服务器指定的 Retry-After。 async for update in handle.iter_events(): print(update.status, update.queue_position) # 提供商自己的响应载荷，与 models.run() 返回的值相同。 # 失败或已取消的请求会在此处抛出类型化的 Router 错误。 result = await handle.get() print(result) asyncio.run(main()) ` `typescript TypeScript theme={null} import { comfy } from "@comfyorg/sdk"; // 从环境变量中读取 COMFY_API_KEY。 // 每次 submit() 调用都会生成自己的 Idempotency-Key，并在自动重试时复用它。 const handle = await comfy.models.submit("ideogram/ideogram-v3", { prompt: "A beautiful mountain landscape", rendering_speed: "TURBO", }); console.log("requestId:", handle.requestId); // 结合模型 ID，这就是另一个进程所需的全部信息 // 轮询直到请求完成，等待服务器指定的 Retry-After。 for await (const update of handle.events()) { console.log(update.status, update.queuePosition); } // 与 models.run() 返回的结果相同。失败或已取消的请求会在此处 reject。 const result = await handle.get(); console.log(result.data); ` `bash cURL theme={null} # 1. 提交。Router 返回 201，以及 request_id、status_url、response_url 和 cancel_url。 curl https://api.comfy.org/v2/models/ideogram/ideogram-v3/requests \ -H "X-API-Key: $COMFY_API_KEY" \ -H "Idempotency-Key: $(uuidgen)" \ -H "Content-Type: application/json" \ -d "{\"prompt\": \"A beautiful mountain landscape\", \"rendering_speed\": \"TURBO\"}" # 2. 轮询直到状态为 COMPLETED，每次响应中指定的 Retry-After 秒数都要等待。 REQUEST_ID="<request_id from the 201 body>" curl -i https://api.comfy.org/v2/models/ideogram/ideogram-v3/requests/$REQUEST_ID/status \ -H "X-API-Key: $COMFY_API_KEY" # 3. 收集。返回 200 时带有模型的原生输出，返回 202 时在仍在运行的情况下带有状态响应体。 curl https://api.comfy.org/v2/models/ideogram/ideogram-v3/requests/$REQUEST_ID \ -H "X-API-Key: $COMFY_API_KEY" ``

Schema

输入

aspect\_ratio string

宽高比，格式为 WxH

color\_palette object

color\_palette.members object[]

显式指定的颜色，可带可选权重

color\_palette.members\[].color string

十六进制颜色代码

color\_palette.members\[].weight number

该颜色的可选权重（0-1）

范围：0 到 1

color\_palette.name string

调色板的名称

magic\_prompt string

是否启用 magic prompt 增强

可选值：AUTO、ON、OFF

negative\_prompt string

用于指定生成时应避免出现内容的文本提示词

num\_images integer

要生成的图像数量

范围：1 到 …

prompt string required

用于图像生成的文本提示词

rendering\_speed string required (default: "DEFAULT")

渲染速度设置，用于控制生成速度与质量之间的权衡

可选值：DEFAULT、TURBO、QUALITY

resolution string

图像分辨率，格式为 WxH

seed integer

用于可复现生成的种子值

style\_codes string[]

十六进制格式的风格代码数组

style\_type string (default: "GENERAL")

可选值：AUTO、GENERAL、REALISTIC、DESIGN、FICTION

根据 Router 在 GET /v2/models/ideogram/ideogram-v3/openapi.json 提供的 schema 生成，该文档与 Router 在请求抵达提供商之前用于校验调用的文档相同。

输出

created string (date-time)

生成创建时的时间戳。

格式：date-time

data object[]

已生成图像的信息数组。

data\[].is\_image\_safe boolean

表示该图像是否被视为安全。

data\[].prompt string

用于生成此图像的提示词。

data\[].resolution string

已生成图像的分辨率（例如 '1024x1024'）。

data\[].seed integer

此次生成所使用的种子值。

data\[].style\_type string

生成所使用的风格类型（例如 'REALISTIC'、'ANIME'）。

data\[].url string

已生成图像的 URL。

示例

输入

{
  "prompt": "A beautiful mountain landscape",
  "rendering_speed": "TURBO"
}

输出

{
  "created": "2026-01-01T00:00:00Z",
  "data": [
    {
      "is_image_safe": true,
      "prompt": "A poster for a jazz festival, bold typography, warm colours",
      "resolution": "1024x1024",
      "seed": 918273645,
      "style_type": "REALISTIC",
      "url": "https://example.invalid/ideogram/ideogram-v3/generated.png"
    }
  ]
}

发布前须知

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。

[card] 请求头身份验证、幂等性、请求 ID、错误分类、重试节奏、消费限额。

[card] 使用 Router API 模型发现、验证错误、重试与计费。

[card] 限制 Router 目前不支持的功能，以及替代方案。