Use Grok Imagine Image with Comfy Router

Call xai/grok-imagine-image through Comfy Router: endpoint, request shape and the response Router returns.

API Reference for xai/grok-imagine-image, served by Comfy Router from xAI.

Quick start

Create a key in your Comfy workspace and export it as COMFY_API_KEY. The Python and TypeScript snippets use the Comfy SDKs (pip install comfy-sdk, npm install @comfyorg/sdk); the cURL snippet is the same call over raw HTTP.

Model ID: xai/grok-imagine-image

Endpoint: POST https://api.comfy.org/v2/models/xai/grok-imagine-image

Python

from comfy_sdk import Comfy

# Reads COMFY_API_KEY from the environment.
# The SDK automatically creates an idempotency key and reuses it for automatic retries.
with Comfy() as client:
    result = client.models.run(
        "xai/grok-imagine-image",
        {
            "n": 1,
            "prompt": "A single red maple leaf on a plain white background.",
        },
    )

print(result)

Schema

Input

aspect_ratio · string · default: "\"auto\""

Aspect ratio of the generated image. Defaults to auto for automatically selecting the best ratio for the prompt.

Possible values: 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\""

Model to be used. Supported: grok-imagine-image (default), grok-imagine-image-pro, grok-imagine-image-quality, grok-imagine-image-2.0. Deprecated -beta ids are aliased to their GA model.

n · integer · default: "1"

Number of images to be generated

Range: 1 to 10

prompt · string · required

Prompt for image generation

quality · string

Quality of the output image. For grok-imagine-image-2.0 this selects the price tier (low/medium; medium is the default); other models currently ignore it.

Possible values: low, medium, high

resolution · string · default: "\"1k\""

Resolution of the generated image. Defaults to 1k.

Possible values: 1k, 2k

response_format · string · default: "\"url\""

Response format to return the image in. Can be url or b64_json. Comfy Router (POST /v2/models/xai/{model}) coerces this to url on the outbound request because it serves image results as re-hosted URLs either way; this /proxy/ route honours it as written.

Possible values: url, b64_json

size · string

Size of the image (not supported)

style · string

Style of the image (not supported)

user · string

A unique identifier representing your end-user, which can help xAI to monitor and detect abuse

Generated from the schema Router serves at GET /v2/models/xai/grok-imagine-image/openapi.json, the same document it validates a call against before the request reaches the provider.

Output

block_reason · string

If the request was blocked by input moderation, contains the block reason

data · object[]

A list of generated image objects

data[].b64_json · string

A base64-encoded string representation of the generated image in jpeg encoding (if response_format is b64_json)

data[].mime_type · string

The MIME type of the generated image (e.g. image/png, image/jpeg, image/webp).

data[].url · string

A url to the generated image (if response_format is url)

usage · object

Usage information for the image generation request

usage.cost_in_usd_ticks · integer

Accurate cost of this request in USD ticks (10,000,000,000 ticks = 1 USD)

Examples

Input

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

Output

{
  "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
  }
}

Before you ship

The SDKs create an Idempotency-Key and reuse it for automatic retries. For manual retries, reuse the original key. Router can hold the connection for up to 10 minutes.

When a request fails, Router sends an X-Comfy-Error-Type response header explaining why. A 422 means Router rejected the input before calling the provider. Download generated assets promptly because result URLs can expire.

Headers

Authentication, idempotency, request IDs, error buckets, retry pacing, spend limits.

Using the Router API

Model discovery, validation errors, retries, and billing.

Limitations

What Router does not do today, and what to use instead.