Skip to main content
xai/grok-imagine-image-quality 的 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-quality 端点: POST https://api.comfy.org/v2/models/xai/grok-imagine-image-quality
同一个请求体,发送到 POST https://api.comfy.org/v2/models/xai/grok-imagine-image-quality/requests。只要运行被接纳,Router 就会返回 201 以及一个 request_id,结果准备就绪后再进行收集,可由当前进程或另一个进程完成。队列化交付 详解了状态、取消和收集的流程。

Schema

输入

string
默认值:"\"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
string
默认值:"\"grok-imagine-image\""
要使用的模型。支持:grok-imagine-image(默认)、grok-imagine-image-pro、grok-imagine-image-quality、grok-imagine-image-2.0。弃用的 -beta id 会被映射到其正式版(GA)模型。
integer
默认值:"1"
要生成的图像数量范围:1 到 10
string
必填
图像生成的提示词
string
输出图像的质量。对于 grok-imagine-image-2.0,此参数用于选择价格档位(low/medium;默认 medium);其他模型目前会忽略该项。可选值:low、medium、high
string
默认值:"\"1k\""
生成图像的分辨率。默认为 1k。可选值:1k、2k
string
默认值:"\"url\""
返回图像所用的响应格式。可以是 url 或 b64_json。Comfy 在向外发出的请求中会将其强制转换为 url:无论是 Comfy Router 的调度(POST /v2/models/xai/{model}),还是此 /proxy/ 路由,都是如此,因为图像结果无论如何都以重新托管的 URL 形式提供。该字段会被接受并忽略,而不会被拒绝;发送它或省略它,得到的答复都一样。可选值:url、b64_json
string
图像的尺寸(不支持)
string
图像风格(不支持)
string
代表你的终端用户的唯一标识符,可帮助 xAI 监控和检测滥用行为
根据 Router 在 GET /v2/models/xai/grok-imagine-image-quality/openapi.json 提供的 schema 生成,这是它在请求到达提供商之前用于校验调用的同一份文档。

输出

string
如果请求被输入审核拦截,则包含拦截原因
object[]
已生成图像对象的列表
string
已生成图像的 base64 编码字符串表示,采用 jpeg 编码(如果 response_format 为 b64_json)
string
已生成图像的 MIME 类型(例如 image/png、image/jpeg、image/webp)。
string
已生成图像的 url(如果 response_format 为 url)
object
图像生成请求的使用信息
integer
此请求的精确成本,以 USD ticks 为单位(10,000,000,000 ticks = 1 USD)

示例

输入

输出

发布前须知

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