配合 Comfy Router 使用 P Image Ideogram

通过 Comfy Router 调用 ideogram/p-image-ideogram：endpoint、请求结构以及 Router 返回的响应。

ideogram/p-image-ideogram 的 API 参考文档，由 Comfy Router 从 Ideogram 提供。

输入： 文本 · 输出： 图像

快速开始

在你的 Comfy 工作区中创建一个密钥，并将其导出为 COMFY_API_KEY。Python 和 TypeScript 代码片段使用 Comfy SDK（pip install comfy-sdk 和 npm install @comfyorg/sdk）；cURL 代码片段则是通过原始 HTTP 发出的同一调用。

模型 ID： ideogram/p-image-ideogram

端点： POST https://api.comfy.org/v2/models/ideogram/p-image-ideogram

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

[tab] 稍后排队并收集将相同的请求体发送到 POST https://api.comfy.org/v2/models/ideogram/p-image-ideogram/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/p-image-ideogram", { "prompt": "A beautiful mountain landscape", }, ) 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/p-image-ideogram", { prompt: "A beautiful mountain landscape", }); 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/p-image-ideogram/requests \ -H "X-API-Key: $COMFY_API_KEY" \ -H "Idempotency-Key: $(uuidgen)" \ -H "Content-Type: application/json" \ -d "{\"prompt\": \"A beautiful mountain landscape\"}" # 2. 轮询直到状态为 COMPLETED，每次响应都会指定需要等待的 Retry-After 秒数。 REQUEST_ID="<request_id from the 201 body>" curl -i https://api.comfy.org/v2/models/ideogram/p-image-ideogram/requests/$REQUEST_ID/status \ -H "X-API-Key: $COMFY_API_KEY" # 3. 收集。返回 200 及模型的原生输出；仍在运行时返回 202 及状态响应体。 curl https://api.comfy.org/v2/models/ideogram/p-image-ideogram/requests/$REQUEST_ID \ -H "X-API-Key: $COMFY_API_KEY" ``

Schema

输入

aspect\_ratio string

宽高比，格式为 WxH。支持的取值：1x3、3x1、1x2、2x1、9x16、16x9、10x16、16x10、2x3、3x2、3x4、4x3、4x5、5x4、1x1。默认为 1x1。

enable\_copyright\_detection boolean

启用生成后的版权检测（Hive 相似度与 logo 检查）。

prompt string required

用于图像生成的提示词，可以是自然语言，也可以是 Ideogram 4.0 JSON 结构化提示词。

prompt\_upsampling string

提示词上采样模式。支持的取值为 AUTO、ON 和 OFF。默认为 AUTO。

quality string

生成质量级别。支持的取值为 VERY\_LOW、LOW、MEDIUM 和 HIGH。默认为 MEDIUM。

resolution string

输出分辨率。支持的取值为 1K 和 2K。默认为 1K。

seed integer

用于可复现生成的种子值

该 Schema 由 Router 在 GET /v2/models/ideogram/p-image-ideogram/openapi.json 提供的文档生成，它也是请求到达提供商之前用于校验调用的同一份文档。

输出

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"
}

输出

{
  "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/p-image-ideogram/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 目前不支持的功能，以及替代方案。