Use Grok Imagine Image with Comfy Router

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

Use xai/grok-imagine-image with the Comfy Router API. xAI provides the model; Router gives it the shared authentication and request route below.

Quick start

Create a key at platform.comfy.org/profile/api-keys 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

import uuid
from comfy_sdk import Comfy

# Reads COMFY_API_KEY from the environment. Save this key and reuse it if you
# retry this request after the SDK returns an error.
idempotency_key = str(uuid.uuid4())
with Comfy() as client:
    result = client.models.run(
        "xai/grok-imagine-image",
        {
            # Request fields are the provider's own — see Input below.
        },
        idempotency_key=idempotency_key,
    )

print(result)

Schema

Input

Router has not published an authored input schema for this model yet: GET /v2/models/xai/grok-imagine-image/openapi.json returns an open object with x-comfy-input-schema-authored: false. Router forwards the body to xAI unchanged, so xAI’s own API reference is authoritative for the request fields, and nothing is validated server side.

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

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

Save one Idempotency-Key for each call and reuse it for retries. Router can hold the connection for up to 10 minutes. The SDKs handle authentication; raw HTTP clients send the headers themselves.

Use X-Comfy-Error-Type to classify a failure. 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

Find models, inspect schemas, and retry safely.

Limitations

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