> ## Documentation Index
> Fetch the complete documentation index at: https://docs.comfy.org/llms.txt
> Use this file to discover all available pages before exploring further.

# Use Grok Imagine Image Quality with Comfy Router

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

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

## Quick start

Create a key in [your Comfy workspace](https://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-quality`

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

<CodeGroup>
  ```python Python theme={null}
  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-quality",
          {
              "n": 1,
              "prompt": "A single red maple leaf on a plain white background.",
          },
      )

  print(result)
  ```

  ```typescript TypeScript theme={null}
  import { comfy } from "@comfyorg/sdk";

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

  console.log(data);
  ```

  ```bash cURL theme={null}
  curl https://api.comfy.org/v2/models/xai/grok-imagine-image-quality \
    -H "X-API-Key: $COMFY_API_KEY" \
    -H "Idempotency-Key: $(uuidgen)" \
    -H "Content-Type: application/json" \
    -d "{\"n\": 1, \"prompt\": \"A single red maple leaf on a plain white background.\"}"
  ```
</CodeGroup>

## Schema

### Input

<ParamField body="aspect_ratio" type="string" default="&#x22;auto&#x22;">
  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`
</ParamField>

<ParamField body="model" type="string" default="&#x22;grok-imagine-image&#x22;">
  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.
</ParamField>

<ParamField body="n" type="integer" default="1">
  Number of images to be generated

  Range: `1` to `10`
</ParamField>

<ParamField body="prompt" type="string" required>
  Prompt for image generation
</ParamField>

<ParamField body="quality" type="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`
</ParamField>

<ParamField body="resolution" type="string" default="&#x22;1k&#x22;">
  Resolution of the generated image. Defaults to 1k.

  Possible values: `1k`, `2k`
</ParamField>

<ParamField body="response_format" type="string" default="&#x22;url&#x22;">
  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`
</ParamField>

<ParamField body="size" type="string">
  Size of the image (not supported)
</ParamField>

<ParamField body="style" type="string">
  Style of the image (not supported)
</ParamField>

<ParamField body="user" type="string">
  A unique identifier representing your end-user, which can help xAI to monitor and detect abuse
</ParamField>

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

### Output

<ResponseField name="block_reason" type="string">
  If the request was blocked by input moderation, contains the block reason
</ResponseField>

<ResponseField name="data" type="object[]">
  A list of generated image objects
</ResponseField>

<ResponseField name="data[].b64_json" type="string">
  A base64-encoded string representation of the generated image in jpeg encoding (if response\_format is b64\_json)
</ResponseField>

<ResponseField name="data[].mime_type" type="string">
  The MIME type of the generated image (e.g. image/png, image/jpeg, image/webp).
</ResponseField>

<ResponseField name="data[].url" type="string">
  A url to the generated image (if response\_format is url)
</ResponseField>

<ResponseField name="usage" type="object">
  Usage information for the image generation request
</ResponseField>

<ResponseField name="usage.cost_in_usd_ticks" type="integer">
  Accurate cost of this request in USD ticks (10,000,000,000 ticks = 1 USD)
</ResponseField>

## Examples

### Input

```json theme={null}
{
  "n": 1,
  "prompt": "A single red maple leaf on a plain white background."
}
```

### Output

```json theme={null}
{
  "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](/development/comfy-router/reference#result-assets).

<CardGroup cols={3}>
  <Card title="Headers" icon="list" href="/development/comfy-router/headers">
    Authentication, idempotency, request IDs, error buckets, retry pacing, spend limits.
  </Card>

  <Card title="Using the Router API" icon="code" href="/development/comfy-router/api">
    Model discovery, validation errors, retries, and billing.
  </Card>

  <Card title="Limitations" icon="triangle-exclamation" href="/development/comfy-router/limitations">
    What Router does not do today, and what to use instead.
  </Card>
</CardGroup>