xai/grok-imagine-image 的 API 参考文档,由 Comfy Router 提供,来源于 xAI。
输入: 图像、文本 · 输出: 图像
快速开始
在你的 Comfy 工作区中创建密钥,并将其导出为COMFY_API_KEY。Python 和 TypeScript 代码片段使用 Comfy SDK(pip install comfy-sdk 和 npm install @comfyorg/sdk);cURL 代码片段则通过原始 HTTP 发起相同的调用。
模型 ID: xai/grok-imagine-image
端点: POST https://api.comfy.org/v2/models/xai/grok-imagine-image
- 等待结果
- 排队并稍后收集
相同的请求体,发送到
POST https://api.comfy.org/v2/models/xai/grok-imagine-image/requests。只要运行被接纳,Router 就会返回 201 和一个 request_id,结果在就绪后再收集,可以在当前进程或另一个进程中收集。排队投递 会讲解状态、取消和收集的完整流程。Schema
输入
已生成图像的长宽比。默认为 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要使用的模型。支持:grok-imagine-image(默认)、grok-imagine-image-pro、grok-imagine-image-quality、grok-imagine-image-2.0。已弃用的 -beta ID 会作为别名指向其 GA 模型。
输出图像的质量。对于 grok-imagine-image-2.0,此项用于选择价格档位:low、medium 或 auto(省略时为 xAI 的默认值;auto 在生成时使用 low,编辑时使用 medium)。其他模型会忽略此项。可能的值:
low, medium, high, auto返回图像所用的响应格式。可以是 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_jsonGET /v2/models/xai/grok-imagine-image/openapi.json 提供的 schema 生成,这与请求到达提供商之前 Router 用于校验调用的文档完全相同。
输出
示例
输入
输出
发布前须知
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。
请求头
身份验证、幂等性、请求 ID、错误分类、重试节奏、消费限额。
使用 Router API
模型发现、验证错误、重试与计费。
限制
Router 目前不支持的功能,以及替代方案。