> ## 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.

# 使用 Comfy Router 调用 Ideogram 4.6

> 通过 Comfy Router 调用 ideogram/ideogram-4-6：端点、请求形状以及 Router 返回的响应。

`ideogram/ideogram-4-6` 的 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-6`

**端点：** `POST https://api.comfy.org/v2/models/ideogram/ideogram-4-6`

> [tab] 等待结果
>
> ```python Python theme={null}
> from comfy_sdk import Comfy
>
> # 从环境变量中读取 COMFY_API_KEY。
> # SDK 会自动创建幂等键，并在自动重试时复用它。
> with Comfy() as client:
>     result = client.models.run(
>         "ideogram/ideogram-4-6",
>         {
>             "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-6", {
>   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-6 \
>   -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\"}"
> ```

> [tab] 入队并稍后收集
>
> 相同的请求体，发送到 `POST https://api.comfy.org/v2/models/ideogram/ideogram-4-6/requests`。只要运行被接纳，Router 就会立即返回 `201` 和 `request_id`；结果就绪后，无论是本进程还是其他进程都可以收集它。[队列投递](https://docs.comfy.org/zh/development/comfy-router/queue.md) 详细介绍了状态、取消和收集的完整流程。
>
> ```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-6",
>             {
>                 "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-6", {
>   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() 返回的结果相同。失败或已取消的请求会在此处被拒绝。
> 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-6/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="<request_id from the 201 body>"
> curl -i https://api.comfy.org/v2/models/ideogram/ideogram-4-6/requests/$REQUEST_ID/status \
>   -H "X-API-Key: $COMFY_API_KEY"
>
> # 3. 收集。返回 200 时为模型的原生输出，仍在运行时返回 202 和状态响应体。
> curl https://api.comfy.org/v2/models/ideogram/ideogram-4-6/requests/$REQUEST_ID \
>   -H "X-API-Key: $COMFY_API_KEY"
> ```

## Schema

### 输入

**background** `string`

仅用于生成。transparent 返回透明度通道；opaque 强制使用纯色背景。

**context\_window** `string`

仅用于 Precise Edit；需要 `image`。auto（默认）表示自动，也可以是一个以 y,x,y,x 表示的区域，用于以完整分辨率编辑 4K 或 8K 图像的一部分，或 none 表示发送整张图像。

**image** `string`

一张图像，可以是 Router 代表调用方获取的 https URL，也可以是内联携带字节的 `data:image/<format>;base64,<payload>` 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（`<account>.r2.cloudflarestorage.com`、`pub-<hash>.r2.dev`）、Amazon S3（`s3.amazonaws.com` 和 `s3.<region>.amazonaws.com`，采用路径样式或带 `<bucket>.` 前缀的形式）、Azure Blob Storage（`<account>.blob.core.windows.net`）以及 Alibaba Cloud OSS（`<bucket>.oss-<region>.aliyuncs.com`，包括 `oss-accelerate` 端点）。这些具体是对象存储端点：同一提供商域上的通用端点，例如阿里云函数计算触发器，不在该列表中，会被拒绝。
匹配的是主机名形式，而不是提供商。因此，在上面提到某个提供商，并不意味着该提供商能够签发的每个 URL 都会被接受；有三种近似但不被接受的情况值得直接说明，因为调用方完全可能带着其中任意一种形式到来。R2 自定义域名（`cdn.example.com`）不被接受：Cloudflare 将 `pub-<hash>.r2.dev` 记录为速率受限的调试主机名，并改为将生产流量指向自定义域名，但自定义域名的主机名中没有任何内容能表明它是 R2，因此 Router 无法将其与任何其他主机区分开来，会拒绝它。请对 `<account>.r2.cloudflarestorage.com` 端点进行预签名，或使用 `pub-<hash>.r2.dev` 形式。S3 的 IPv6 dualstack 端点（`s3.dualstack.<region>.amazonaws.com`）也不被接受；请使用普通的区域端点。Azure Blob 的备用 DNS 区域（`<account>.z<N>.blob.storage.azure.net`）同样不被接受；请使用 `<account>.blob.core.windows.net`。你收到的拒绝信息会列出这些相同的形式，因此你不必到这里来阅读它们。
上面的 `<account>` 和 `pub-<hash>` 占位符展示的是你通常会采用的形式；它们不是深度限制。匹配依据是对象存储域后缀，因此同一命名空间下更深层的名称（`a.b.pub-<hash>.r2.dev`）也会被接受。不会因此被放宽的是命名空间本身，后缀仍然必须是所列出的后缀之一。
下面的示例仅展示形式：真实值还会携带签名查询参数，这里有意省略了这些参数，因为已发布的示例会永久留在规范中，而真实签名既是被泄露的凭证，也是会失效的链接。
每张图像上限为 25 MiB，单次请求的所有图像总计上限为 64 MiB。唯一的例外是 ideogram/ideogram-4-5 Precise Edit（即发送 `image` 并且可以使用 `context_window` 的调用）：在该情况下，每张图像最多可达 50 MB（50,000,000 字节）和 67,108,864 像素，单次请求的所有图像总计最大为 128 MiB。

**images** `string[]`

生成操作的可选源图像。第一张会被编辑，其余作为参考图。最多五张。

**magic\_prompt** `string`

仅生成。提示词重写。支持的值为 auto、on 和 off。带图像的请求始终使用 auto。

**mask** `string`

一张图像，可以是 Router 代表调用方获取的 https URL，也可以是携带内联字节的 `data:image/<format>;base64,<payload>` 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（`<account>.r2.cloudflarestorage.com`、`pub-<hash>.r2.dev`）、Amazon S3（`s3.amazonaws.com` 和 `s3.<region>.amazonaws.com`，采用路径样式或带 `<bucket>.` 前缀的形式）、Azure Blob Storage（`<account>.blob.core.windows.net`）以及 Alibaba Cloud OSS（`<bucket>.oss-<region>.aliyuncs.com`，包括 `oss-accelerate` 端点）。这些具体是对象存储端点：同一提供商域名上的通用端点，例如 Alibaba Function Compute 触发器，不在列表中，会被拒绝。

匹配的是主机名形式，而不是提供商。因此，上面提到某个提供商并不意味着该提供商可以签发的每个 URL 都会被接受，有三种近似情况值得直接说明，因为调用方完全可能带着其中每一种情况前来。R2 自定义域名（`cdn.example.com`）不被接受：Cloudflare 将 `pub-<hash>.r2.dev` 记录为限速的调试主机名，并将生产流量指向自定义域名，但自定义域名的主机名中没有任何内容表明它是 R2，因此 Router 无法将其与任何其他主机区分开来，并会拒绝它。请对 `<account>.r2.cloudflarestorage.com` 端点进行预签名，或使用 `pub-<hash>.r2.dev` 形式。S3 的 IPv6 双栈端点（`s3.dualstack.<region>.amazonaws.com`）也不被接受；请使用普通区域端点。Azure Blob 的备用 DNS 区域（`<account>.z<N>.blob.storage.azure.net`）同样不被接受；请使用 `<account>.blob.core.windows.net`。你收到的拒绝信息会列出这些相同的形式，因此你不必来这里阅读它们。

上面的 `<account>` 和 `pub-<hash>` 占位符展示了你通常会遇到的形式；它们不是深度限制。匹配基于对象存储域名后缀，因此同一命名空间下更深的名称（`a.b.pub-<hash>.r2.dev`）也会被接受。这并没有扩大命名空间本身，后缀仍然必须是所列后缀之一。

下面的示例仅展示形状：真实值还携带签名查询参数，这里故意省略它们，因为已发布的示例会永远留在规范中，而真实签名既是泄露的凭证，也是会失效的链接。

每张图像上限为 25 MiB，一个请求的图像总计上限为 64 MiB。唯一的例外是 ideogram/ideogram-4-5 Precise Edit（发送 `image` 的调用），其中 `context_window` 可用：在那里，每张图像最多可为 50 MB（50,000,000 字节）和 67,108,864 像素，一个请求的图像总计最多为 128 MiB。

**num\_images** `integer` (default: 1)

要返回的图像数量。每张都会计费。

范围：`1` 到 `8`

**prompt** `string` *required*

图像描述，或者在带图像时，为编辑指令。1 到 10,000 个字符。

**quality** `string`

质量层级。默认为 medium。very\_low 最高可渲染 2K。计费费率取决于质量、请求是否为编辑以及输出是否高于 2K。

可选值：`very_low`、`low`、`medium`、`high`

**reference\_images** `string[]`

仅限 Precise Edit；需要 `image`。用于引导编辑的可选图像。最多四张，使用遮罩时最多三张。

**seed** `integer`

用于可复现结果的种子。

范围：`0` 到 `2147483647`

**size** `string`

仅用于生成。auto（默认）会选择约 2K。WIDTHxHEIGHT 基于 32 像素网格，最高可达 16,777,216 像素，边长最大 8192，比例为 6:1，或使用 `source` 以匹配 `images` 中的第一张。

根据 Router 在 `GET /v2/models/ideogram/ideogram-4-6/openapi.json` 提供的 schema 生成，该 schema 也是 Router 在请求到达提供商之前用于验证调用的同一份文档。

### 输出

**data** `object[]`

已生成的图像。

**data\[].is\_image\_safe** `boolean`

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

**data\[].resolution** `string`

图像尺寸，格式为 WIDTHxHEIGHT，例如 1600x1280。

**data\[].seed** `integer`

用于该图像的种子。

**data\[].url** `string`

图像的临时 URL。请将图像复制到你自己的存储中。

**generation\_id** `string`

本次生成的标识符。

**seed** `integer`

用于本次生成的种子。

## 示例

### 输入

```json theme={null}
{
  "prompt": "A poster for a jazz festival, bold typography, warm colours",
  "quality": "low"
}
```

### 输出

```json theme={null}
{
  "data": [
    {
      "is_image_safe": true,
      "resolution": "2048x2048",
      "seed": 918273645,
      "url": "https://example.invalid/ideogram/ideogram-4-6/generated.png"
    }
  ],
  "generation_id": "gen_0123456789",
  "seed": 918273645
}
```

## 发布前须知

SDK 会生成 `Idempotency-Key` 并在自动重试中复用它。手动重试时，请复用原始 key。Router 最长可保持连接 10 分钟。

请求失败时，Router 会发送 `X-Comfy-Error-Type` 响应头说明原因。`422` 表示 Router 在调用提供商之前就拒绝了输入，`413` 表示请求体超出了 Router 可接受的大小。已生成的资源请及时下载，因为[结果 URL 会过期](https://docs.comfy.org/zh/development/comfy-router/reference.md#结果资产)。

上文任何字段描述中提到的尺寸限制，都是提供商对该字段自身的限定，引自提供商的规范。Router 会对整个请求体另行设置上限，base64 编码的媒体内容也计入其中：参见[请求体大小](https://docs.comfy.org/zh/development/comfy-router/limitations.md)。

本页记录的是通过 Comfy Router 调用的某一个合作伙伴模型。同一个 `comfy-sdk` / `@comfyorg/sdk` 包还提供第二个客户端，用于在 Comfy Cloud 上运行完整的 ComfyUI 工作流图：`Comfy(api_key=...)` / `new Comfy({ apiKey })`，并带有 `client.workflows`、`client.assets` 和 `client.jobs`。请参阅 [Comfy SDKs](https://docs.comfy.org/zh/development/api-development/sdks.md)。

> [card] [请求头](https://docs.comfy.org/zh/development/comfy-router/headers.md)
>
> 身份验证、幂等性、请求 ID、错误分类、重试节奏、消费限额。

> [card] [使用 Router API](https://docs.comfy.org/zh/development/comfy-router/api.md)
>
> 模型发现、验证错误、重试与计费。

> [card] [限制](https://docs.comfy.org/zh/development/comfy-router/limitations.md)
>
> Router 目前不支持的功能，以及替代方案。


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.