配合 Comfy Router 使用 Grok Imagine Image Quality

通过 Comfy Router 调用 xai/grok-imagine-image-quality：端点、请求结构与 Router 返回的响应。

xai/grok-imagine-image-quality 的 API 参考，由 Comfy Router 提供，来自 xAI。

输入： 文本 · 输出： 图像

[!WARNING] xAI 已于 2026 年 11 月 2 日停用 grok-imagine-image-quality。现在请求由 grok-imagine-image-2.0 以低质量提供服务。参见 xAI 的迁移通知。

快速开始

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

模型 ID： xai/grok-imagine-image-quality

端点： POST https://api.comfy.org/v2/models/xai/grok-imagine-image-quality

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

[tab] 加入队列并稍后收集同一个请求体，发送到 POST https://api.comfy.org/v2/models/xai/grok-imagine-image-quality/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( "xai/grok-imagine-image-quality", { "n": 1, "prompt": "A single red maple leaf on a plain white background.", }, ) 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("xai/grok-imagine-image-quality", { n: 1, prompt: "A single red maple leaf on a plain white background.", }); 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/xai/grok-imagine-image-quality/requests \ -H "X-API-Key: $COMFY_API_KEY" \ -H "Idempotency-Key: $(uuidgen)" \ -H "Content-Type: application/json" \ -d "{\"n\": 1, \"prompt\": \"A single red maple leaf on a plain white background.\"}" # 2. 轮询直到状态为 COMPLETED，按每次响应指定的 Retry-After 秒数等待。 REQUEST_ID="<request_id from the 201 body>" curl -i https://api.comfy.org/v2/models/xai/grok-imagine-image-quality/requests/$REQUEST_ID/status \ -H "X-API-Key: $COMFY_API_KEY" # 3. 收集。返回 200 及模型的原始输出，仍在运行时返回 202 及状态响应体。 curl https://api.comfy.org/v2/models/xai/grok-imagine-image-quality/requests/$REQUEST_ID \ -H "X-API-Key: $COMFY_API_KEY" ``

Schema

输入

aspect\_ratio string (default: "auto")

生成图像的宽高比。默认为 auto，即为提示词自动选择最佳比例。

可选值：1:1、3:4、4:3、9:16、16:9、2:3、3:2、9:19.5、19.5:9、9:20、20:9、1:2、2:1、auto

model string (default: "grok-imagine-image")

要使用的模型。支持：grok-imagine-image（默认）、grok-imagine-image-pro、grok-imagine-image-quality、grok-imagine-image-2.0。弃用的 -beta id 会被映射到其正式版（GA）模型。

n integer (default: 1)

要生成的图像数量

范围：1 到 10

prompt string required

图像生成的提示词

quality string

输出图像的质量。对于 grok-imagine-image-2.0，此项用于选择价格档位：low、medium 或 auto（省略时为 xAI 的默认值；auto 在生成时使用 low，编辑时使用 medium）。其他模型会忽略此项。

可能的值：low、medium、high、auto

resolution string (default: "1k")

生成图像的分辨率。默认为 1k。

可选值：1k、2k

response\_format string (default: "url")

返回图像所用的响应格式。可以是 url 或 b64\_json。Comfy 在向外发出的请求中会将其强制转换为 url：无论是 Comfy Router 的调度（POST /v2/models/xai/{model}），还是此 /proxy/ 路由，都是如此，因为图像结果无论如何都以重新托管的 URL 形式提供。enum 内的值会被接受并忽略；发送 url 或 b64_json，或省略该字段，结果都一样。enum 之外的值（不包括下文所述两处各自识别的 UNSET 写法）在两处都不会被强制转换，而是会被拒绝，区别仅在于拒绝的形式：此 /proxy/ 路由在入口处返回 400，而 POST /v2/models/xai/{model} 的 Router 调度会在任何合作伙伴调用之前，返回此处所公布 enum 对应的字段级 422。两处对 UNSET 的判定不同：在此 /proxy/ 路由上，省略字段、显式传入 null 和 "" 都表示未设置，并像任何被接受的值一样被强制转换；Router 调度严格按公布的 enum 执行，因此 null 和 "" 与其他非成员一样被视为非成员，要在该处保持未设置，请省略该字段。

可选值：url、b64_json

size string

图像的尺寸（不支持）

style string

图像风格（不支持）

user string

代表你的终端用户的唯一标识符，可帮助 xAI 监控和检测滥用行为

根据 Router 在 GET /v2/models/xai/grok-imagine-image-quality/openapi.json 提供的 schema 生成，这是它在请求到达提供商之前用于校验调用的同一份文档。

输出

block\_reason string

如果请求被输入审核拦截，则包含拦截原因

data object[]

已生成图像对象的列表

data\[].b64\_json string

已生成图像的 base64 编码字符串表示，采用 jpeg 编码（如果 response\_format 为 b64\_json）

data\[].mime\_type string

已生成图像的 MIME 类型（例如 image/png、image/jpeg、image/webp）。

data\[].url string

已生成图像的 url（如果 response\_format 为 url）

usage object

图像生成请求的使用信息

usage.cost\_in\_usd\_ticks integer

此请求的精确成本，以 USD ticks 为单位（10,000,000,000 ticks = 1 USD）

示例

输入

{
  "n": 1,
  "prompt": "A single red maple leaf on a plain white background."
}

输出

{
  "data": [
    {
      "mime_type": "image/jpeg",
      "url": "https://example.invalid/xai/grok-imagine-image/generated.jpg"
    },
    {
      "mime_type": "image/jpeg",
      "url": "https://example.invalid/xai/grok-imagine-image/generated-2.jpg"
    }
  ],
  "usage": {
    "cost_in_usd_ticks": 200000000
  }
}

发布前须知

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