Skip to main content
API Reference for xai/grok-imagine-image-2.0, served by Comfy Router from xAI.

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-2.0 Endpoint: POST https://api.comfy.org/v2/models/xai/grok-imagine-image-2.0

Schema

Input

Router has not published an authored input schema for this model yet: GET /v2/models/xai/grok-imagine-image-2.0/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

string
If the request was blocked by input moderation, contains the block reason
object[]
A list of generated image objects
string
A base64-encoded string representation of the generated image in jpeg encoding (if response_format is b64_json)
string
The MIME type of the generated image (e.g. image/png, image/jpeg, image/webp).
string
A url to the generated image (if response_format is url)
object
Usage information for the image generation request
integer
Accurate cost of this request in USD ticks (10,000,000,000 ticks = 1 USD)

Examples

Output

Before you ship

The snippets above are the shortest working call. Three things are the same for every model and are documented once on the Comfy Router headers page: send an Idempotency-Key on every paid call and reuse it when you retry, expect the connection to be held up to Router’s 10 minute deadline, and keep X-Comfy-Request-Id from every response. The SDKs do all three for you; the cURL tab does none of them. On failure, X-Comfy-Error-Type names the bucket, and a 422 means the body failed the model’s schema and was never billed.

Headers

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

Quick Start

Typed error handling in Python and TypeScript, reading the 422, walking the catalog.

Limitations

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