> ## Documentation Index > Fetch the complete documentation index at: https://docs.comfy.org/llms.txt > Use this file to discover all available pages before exploring further. # 将 Ideogram 4.5 与 Comfy Router 配合使用 > 通过 Comfy Router 调用 ideogram/ideogram-4-5：endpoint、请求结构以及 Router 返回的响应。 `ideogram/ideogram-4-5` 的 API 参考，由 Comfy Router 提供，模型源自 Ideogram。 **输入：** 文本, 图像 · **输出：** 图像 ## 快速开始 在[你的 Comfy 工作区](https://platform.comfy.org/profile/api-keys?onboarding=router)中创建一个密钥，并将其导出为 `COMFY_API_KEY`。Python 和 TypeScript 代码片段使用 Comfy SDK（`pip install comfy-sdk` 和 `npm install @comfyorg/sdk`）；cURL 代码片段则是通过原生 HTTP 发出的同一个调用。 **模型 ID：** `ideogram/ideogram-4-5` **端点：** `POST https://api.comfy.org/v2/models/ideogram/ideogram-4-5` ```python Python theme={null} from comfy_sdk import Comfy # 从环境变量中读取 COMFY_API_KEY。 # SDK 会自动创建幂等键，并在自动重试时复用它。 with Comfy() as client: result = client.models.run( "ideogram/ideogram-4-5", { "prompt": "A poster for a jazz festival, bold typography, warm colours", "quality": "low", }, ) print(result) ``` ```typescript TypeScript theme={null} import { comfy } from "@comfyorg/sdk"; // 从环境变量中读取 COMFY_API_KEY。 // SDK 会自动创建幂等键，并在自动重试时复用它。 const { data } = await comfy.models.run("ideogram/ideogram-4-5", { prompt: "A poster for a jazz festival, bold typography, warm colours", quality: "low", }); console.log(data); ``` ```bash cURL theme={null} curl https://api.comfy.org/v2/models/ideogram/ideogram-4-5 \ -H "X-API-Key: $COMFY_API_KEY" \ -H "Idempotency-Key: $(uuidgen)" \ -H "Content-Type: application/json" \ -d "{\"prompt\": \"A poster for a jazz festival, bold typography, warm colours\", \"quality\": \"low\"}" ``` 相同的请求体，发送到 `POST https://api.comfy.org/v2/models/ideogram/ideogram-4-5/requests`。请求一旦被接纳，Router 就会以 `201` 返回 `request_id`，结果就绪后即可从当前进程或其他进程收集。[队列投递](/zh/development/comfy-router/queue) 介绍了状态、取消与结果收集的完整流程。 ```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-4-5", { "prompt": "A poster for a jazz festival, bold typography, warm colours", "quality": "low", }, ) 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-4-5", { prompt: "A poster for a jazz festival, bold typography, warm colours", quality: "low", }); 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-4-5/requests \ -H "X-API-Key: $COMFY_API_KEY" \ -H "Idempotency-Key: $(uuidgen)" \ -H "Content-Type: application/json" \ -d "{\"prompt\": \"A poster for a jazz festival, bold typography, warm colours\", \"quality\": \"low\"}" # 2. 轮询直到 status 为 COMPLETED，每次响应都会指定需要等待的 Retry-After 秒数。 REQUEST_ID="" curl -i https://api.comfy.org/v2/models/ideogram/ideogram-4-5/requests/$REQUEST_ID/status \ -H "X-API-Key: $COMFY_API_KEY" # 3. 收集。200 返回模型的原始输出，仍在运行时 202 返回状态体。 curl https://api.comfy.org/v2/models/ideogram/ideogram-4-5/requests/$REQUEST_ID \ -H "X-API-Key: $COMFY_API_KEY" ``` ## Schema ### 输入 选择启用生成后的版权检测。 一张图像，可以是 Router 代表调用方获取的 https URL，也可以是内联携带字节的 `data:image/;base64,` URI。接受的图像类型为 png、webp 和 jpeg，该集合在解析时即强制执行，而不是留给提供商决定：svg、gif、avif 或 tiff 会在这里被拒绝，并指明你发送的图像，而不会变成距离根因两跳之外的合作伙伴错误。 优先使用 URL 形式。base64 载荷大约膨胀到 4/3，而整个请求体上限为 100 MiB，因此内联形式的上限约为 75 MB 的来源图像；URL 则完全绕开了这一点。本描述末尾给出的单张图像与单次请求的媒体上限比请求体上限更严格，因此对于任何有实际大小的图像，你首先遇到的都是它们。 该 URL 必须无需你的凭证即可解析。Router 在服务器端获取它，并且不会随请求发送任何调用方凭证，因此受支持的形式是预签名 URL（签名位于查询字符串中的 URL）。诸如 `/api/assets/{id}/content` 这类需要认证的端点会向 Router 返回 401 而不是图像；请自行请求该 URL，并传入它重定向到的已签名 URL。 获取范围被限定在一组指定的主机内，而不是整个开放互联网；同一列表会同时应用于你发送的 URL 以及每一次重定向跳转，因此在联系任何提供商之前，位于其他主机的 URL，或者重定向到列表之外主机的 URL，都会被拒绝。目前该列表仅包含 Comfy 自己的资产分发：Comfy 资产桶下已签名的 `storage.googleapis.com` URL，也就是 `/api/assets/{id}/content` 重定向你到的形式。合作伙伴 CDN 或普通 https 主机都不在列表中。 有两项放宽正在逐步推出，且目前两者都默认关闭。它们由同一个切换开关控制并一起启用，因此请把下面的所有内容视为即将推出的功能，而不是现在就可以依赖的东西：在使用其中任何一项之前请先询问。 第一项是 `POST /customers/storage` 为你的上传签名的桶。在推出到达你的环境之前，来自该端点的上传 URL 会在这里被拒绝，即使该桶是 Comfy 自己的、主机也相同：因此“上传到 Comfy，再传入 URL”目前并不奏效，可行的形式是 `/api/assets/{id}/content` 重定向到的已签名 URL。 第二项是按账户启用，而不是一次性对所有人启用，因为这些主机背后的桶属于你而不是我们：即使上面的切换开关已打开，尚未启用第三方入站媒体的账户仍会被拒绝，并且给出的提示正是这句话，而不是告诉你主机不受支持。请联系你的 Comfy 对接人，为你的账户启用它。它额外允许以下第三方对象存储主机，这些主机背后的桶属于你，Router 不对其主张任何所属权：Cloudflare R2（`.r2.cloudflarestorage.com`、`pub-.r2.dev`）、Amazon S3（`s3.amazonaws.com` 以及 `s3..amazonaws.com`，path-style 或带 `.` 前缀的形式均可）、Azure Blob Storage（`.blob.core.windows.net`）和 Alibaba Cloud OSS（`.oss-.aliyuncs.com`，包括 `oss-accelerate` 端点）。这些特指对象存储端点：同一提供商域名上的通用端点，例如阿里云函数计算的触发器，不在列表中，会被拒绝。 匹配的是主机名形式，而不是提供商：因此上面提到某个提供商，并不代表该提供商能签发的每个 URL 都会被接受；有三种容易混淆的情况值得直接说明，因为调用方完全可能带着其中任何一种前来。R2 自定义域名（`cdn.example.com`）不被接受：Cloudflare 将 `pub-.r2.dev` 记录为有限速的调试主机名，并改为把生产流量指向自定义域名；但自定义域名的主机名中没有任何信息表明它是 R2，Router 无法将其与其他主机区分开，因而会拒绝它。请对 `.r2.cloudflarestorage.com` 端点预签名，或使用 `pub-.r2.dev` 形式。S3 的 IPv6 dualstack 端点（`s3.dualstack..amazonaws.com`）同样不被接受，请使用普通的区域端点。Azure Blob 的备用 DNS 区域（`.z.blob.storage.azure.net`）也不被接受，请使用 `.blob.core.windows.net`。你收到的拒绝信息会列出这些相同的形式，因此不必专门来这里查看。 上面的 `` 和 `pub-` 占位符展示的是你通常会用的形式，它们并不是层级深度的限制。匹配针对的是对象存储域名后缀，因此同一命名空间下更深的名字（`a.b.pub-.r2.dev`）同样会被接受。这并未放宽命名空间本身：后缀仍然必须是所列出的后缀之一。 下面的示例只展示形式：真实的值还带有签名查询参数，此处有意省略，因为已发布的示例会永远留在规范中，而真实的签名既会泄露凭证，也是一个会失效的链接。 每张图像上限为 25 MiB，单次请求的图像总量上限为 64 MiB。 生成操作的可选来源图像。第一张是主要来源，其余为参考图。最多五张，带遮罩时最多四张。 仅用于生成。用于文生图的提示词重写。支持的值为 auto、on 和 off。默认为 auto。 单张图像，可以是 Router 代表调用方获取的 https URL，也可以是内联携带字节的 `data:image/;base64,` URI。接受的图像类型为 png、webp 和 jpeg，并且该集合在解析时即被强制校验，而不是交由提供商处理：svg、gif、avif 或 tiff 会在此处被拒绝，并指明你发送的图像，而不是变成与原因相隔两跳的合作伙伴错误。 优先使用 URL 形式。base64 负载大约膨胀 4/3，整个请求体上限为 100 MiB，因此内联形式对应的来源图像上限约为 75 MB；URL 则完全避开这一限制。本描述末尾说明的每张图像和每请求媒体上限比请求体上限更严格，因此对于任何实际大小的图像，你会先遇到它们。 该 URL 必须在不使用你的凭证的情况下可解析。Router 在服务器端获取它，并且请求中不发送调用方凭证，因此预签名 URL（其签名位于查询字符串中）是受支持的形式。诸如 `/api/assets/{id}/content` 这类需要认证的端点会向 Router 返回 401 而不是图像；请自行请求该 URL，并传递它重定向到的已签名 URL。 获取仅限于一组具名主机，而不是开放互联网，并且同一列表会重新应用于你发送的 URL 以及每个重定向跳；因此任何其他主机上的 URL，或重定向离开该列表的 URL，都会在联系任何提供商之前被拒绝。目前该列表仅包含 Comfy 自身的资产分发：Comfy 资产桶下的已签名 `storage.googleapis.com` URL，这正是 `/api/assets/{id}/content` 重定向你前往的形式。合作伙伴 CDN 或普通 https 主机不在该列表上。 两项放宽正在逐步推出，并且目前默认均处于关闭状态。它们通过一个开关发布并一起启用，因此请将以下所有内容视为即将推出，而不是现在就可以依赖的功能：在依赖其中任何一项之前请先询问。 第一项是 `POST /customers/storage` 将你的上传签名到的桶。在推出到达你的环境之前，来自该端点的上传 URL 会在此处被拒绝，即使该桶属于 Comfy 自身且主机相同：因此“上传到 Comfy，然后传递 URL”尚不可行，可行的形式是 `/api/assets/{id}/content` 重定向到的已签名 URL。 第二项是按账户启用，而不是一次为所有人启用，因为这些主机背后的桶是你的而不是我们的：即使上面的开关已打开，未启用第三方入站媒体的账户仍会被拒绝，并会收到这样的说明，而不是被告知不支持该主机。请让你的 Comfy 联系人为此账户启用它。它还额外接受这些第三方对象存储主机，其中桶属于你，Router 不对其提出所有权主张：Cloudflare R2（`.r2.cloudflarestorage.com`、`pub-.r2.dev`）、Amazon S3（`s3.amazonaws.com` 和 `s3..amazonaws.com`，路径样式或 `.` 前缀形式均可）、Azure Blob Storage（`.blob.core.windows.net`）以及阿里云 OSS（`.oss-.aliyuncs.com`，包括 `oss-accelerate` 端点）。这些具体是对象存储端点：同一提供商域上的常规用途端点，例如阿里云函数计算触发器，不在列表上并会被拒绝。 匹配的是主机名形式，而不是提供商：因此在上文提及某个提供商，并不意味着该提供商可以签发的每个 URL 都会被接受，而三个近似情况值得直接说明，因为调用方可能合理地带着其中任何一个到来。R2 自定义域名（`cdn.example.com`）不被接受：Cloudflare 将 `pub-.r2.dev` 记录为限速的调试主机名，并将生产流量指向自定义域名，但自定义域名的域名中不包含任何标识其为 R2 的信息，因此 Router 无法将其与任何其他主机区分开来并拒绝它：请对 `.r2.cloudflarestorage.com` 端点进行预签名，或使用 `pub-.r2.dev` 形式。S3 的 IPv6 双栈端点（`s3.dualstack..amazonaws.com`）也不被接受；请使用普通的区域端点。Azure Blob 的备用 DNS 区域（`.z.blob.storage.azure.net`）同样不被接受；请使用 `.blob.core.windows.net`。你收到的拒绝信息会列出这些相同的形式，因此你不必来这里阅读它们。 上面的 `` 和 `pub-` 占位符展示了你通常会使用的形式；它们不是深度限制。匹配基于对象存储域后缀，因此同一命名空间下的更深层名称（`a.b.pub-.r2.dev`）也会被接受。这不会放宽命名空间本身：后缀仍然必须是所列之一。 下面的示例仅展示形状：真实值还带有签名查询参数，这里故意省略，因为已发布的示例会永远留在规范中，而真实签名既是泄露的凭证，也是会失效的链接。 每张图像上限为 25 MiB，单个请求的图像总计上限为 64 MiB。 要返回的图像数量。每张图像都会计费。 范围：`1` 到 `8` 图像的指令或描述，1 到 10,000 个字符。 质量层级，同时也是计费费率。有来源图像时：very\_low、low、medium 或 high（默认 medium）。无来源图像时：low、medium 或 high（默认 high）；在文生图请求中使用 very\_low 会被拒绝。 可能的值：`very_low`、`low`、`medium`、`high` 用于 Precise Edit 的可选参考图像；需要 `image`。最多四张，带有遮罩时为三张。 用于可复现结果的种子。 范围：`0` 到 `2147483647` 仅用于生成。输出尺寸。`auto`（默认）、`source`（需要提供图像）或 `WIDTHxHEIGHT`。发送遮罩时请省略该项；同时设置两者的请求会被拒绝。 由 Router 在 `GET /v2/models/ideogram/ideogram-4-5/openapi.json` 提供的 schema 生成，它也是请求到达提供商之前用于校验调用的同一份文档。 ### 输出 已生成的图像。 表示该图像是否被认为 true安全的。请仅使用此值为 true 的图像。 用于生成此图像的提示词。 已生成图像的分辨率。 用于此图像的种子。 已生成图像的 URL。 本次生成的标识符。 用于本次生成的种子。 ## 示例 ### 输入 ```json theme={null} { "prompt": "A poster for a jazz festival, bold typography, warm colours", "quality": "low" } ``` ### 输出 ```json theme={null} { "data": [ { "is_image_safe": true, "prompt": "A poster for a jazz festival, bold typography, warm colours", "resolution": "2048x2048", "seed": 918273645, "url": "https://example.invalid/ideogram/ideogram-4-5/generated.png" } ], "generation_id": "gen_0123456789", "seed": 918273645 } ``` ## 发布前须知 SDK 会生成 `Idempotency-Key` 并在自动重试中复用它。手动重试时，请复用原始 key。Router 最长可保持连接 10 分钟。 请求失败时，Router 会发送 `X-Comfy-Error-Type` 响应头说明原因。`422` 表示 Router 在调用提供商之前就拒绝了输入，`413` 表示请求体超出了 Router 可接受的大小。已生成的资源请及时下载，因为[结果 URL 会过期](/zh/development/comfy-router/reference#结果资产)。 上文任何字段描述中提到的尺寸限制，都是提供商对该字段自身的限定，引自提供商的规范。Router 会对整个请求体另行设置上限，base64 编码的媒体内容也计入其中：参见[请求体大小](/zh/development/comfy-router/limitations)。 本页记录的是通过 Comfy Router 调用的某一个合作伙伴模型。同一个 `comfy-sdk` / `@comfyorg/sdk` 包还提供第二个客户端，用于在 Comfy Cloud 上运行完整的 ComfyUI 工作流图：`Comfy(api_key=...)` / `new Comfy({ apiKey })`，并带有 `client.workflows`、`client.assets` 和 `client.jobs`。请参阅 [Comfy SDKs](/zh/development/api-development/sdks)。 身份验证、幂等性、请求 ID、错误分类、重试节奏、消费限额。 模型发现、验证错误、重试与计费。 Router 目前不支持的功能，以及替代方案。 This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.