> ## Documentation Index
> Fetch the complete documentation index at: https://dripart-stale2000-router-model-pages.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Use GPT Image 2 with Comfy Router

> Call openai/gpt-image-2 through Comfy Router: endpoint, request shape and the response Router returns.

Use `openai/gpt-image-2` with the Comfy Router API. OpenAI 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](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:** `openai/gpt-image-2`

**Endpoint:** `POST https://api.comfy.org/v2/models/openai/gpt-image-2`

<CodeGroup>
  ```python Python theme={null}
  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(
          "openai/gpt-image-2",
          {
              # Request fields are the provider's own — see Input below.
          },
          idempotency_key=idempotency_key,
      )

  print(result)
  ```

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

  // Reads COMFY_API_KEY from the environment. Save this key and reuse it if you
  // retry this request after the SDK returns an error.
  const idempotencyKey = crypto.randomUUID();
  const { data } = await comfy.models.run("openai/gpt-image-2", {
    // Request fields are the provider's own — see Input below.
  }, { idempotencyKey });

  console.log(data);
  ```

  ```bash cURL theme={null}
  # Request fields are the provider's own — see Input below.
  # Run this line once. Reuse ROUTER_REQUEST_KEY if you retry the curl command.
  ROUTER_REQUEST_KEY=$(uuidgen)
  curl https://api.comfy.org/v2/models/openai/gpt-image-2 \
    -H "X-API-Key: $COMFY_API_KEY" \
    -H "Idempotency-Key: $ROUTER_REQUEST_KEY" \
    -H "Content-Type: application/json" \
    -d '{}'
  ```
</CodeGroup>

## Schema

### Input

<ParamField body="background" type="string">
  Background transparency

  Possible values: `transparent`, `opaque`
</ParamField>

<ParamField body="model" type="string">
  The model to use for image generation (e.g., gpt-image-1, gpt-image-1.5, gpt-image-2)
</ParamField>

<ParamField body="moderation" type="string">
  Content moderation setting

  Possible values: `low`, `auto`
</ParamField>

<ParamField body="n" type="integer">
  The number of images to generate (1-10).
</ParamField>

<ParamField body="output_compression" type="integer">
  Compression level for JPEG or WebP (0-100)
</ParamField>

<ParamField body="output_format" type="string">
  Format of the output image

  Possible values: `png`, `webp`, `jpeg`
</ParamField>

<ParamField body="prompt" type="string" required>
  A text description of the desired image
</ParamField>

<ParamField body="quality" type="string">
  The quality of the generated image

  Possible values: `low`, `medium`, `high`, `standard`, `hd`
</ParamField>

<ParamField body="response_format" type="string">
  Response format of image data

  Possible values: `url`, `b64_json`
</ParamField>

<ParamField body="size" type="string">
  Size of the image (e.g., 1024x1024, 1536x1024, auto)
</ParamField>

<ParamField body="style" type="string">
  Style of the image. Unused by the gpt-image models this operation admits; it was a dall-e-3-only parameter and those ids were retired when OpenAI shut them down on 2026-05-12.

  Possible values: `vivid`, `natural`
</ParamField>

<ParamField body="user" type="string">
  A unique identifier for end-user monitoring
</ParamField>

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

### Output

<ResponseField name="data" type="object[]" />

<ResponseField name="data[].b64_json" type="string">
  Base64 encoded image data
</ResponseField>

<ResponseField name="data[].revised_prompt" type="string">
  Revised prompt
</ResponseField>

<ResponseField name="data[].url" type="string">
  URL of the image
</ResponseField>

<ResponseField name="usage" type="object" />

<ResponseField name="usage.input_tokens" type="integer" />

<ResponseField name="usage.input_tokens_details" type="object" />

<ResponseField name="usage.input_tokens_details.image_tokens" type="integer" />

<ResponseField name="usage.input_tokens_details.text_tokens" type="integer" />

<ResponseField name="usage.output_tokens" type="integer" />

<ResponseField name="usage.output_tokens_details" type="object" />

<ResponseField name="usage.output_tokens_details.image_tokens" type="integer" />

<ResponseField name="usage.output_tokens_details.text_tokens" type="integer" />

<ResponseField name="usage.total_tokens" type="integer" />

<ResponseField name="background" type="string">
  Whether the generated image's background is opaque or transparent. Populated on the fal-served branch only, which reports `opaque`.
</ResponseField>

<ResponseField name="created" type="integer">
  Unix timestamp, in seconds, of when the generation completed. Declared `int64` because a present-day epoch value is close enough to 2^31 that an unformatted `integer` generates a 32-bit field in many SDK generators.

  Format: `int64`
</ResponseField>

<ResponseField name="output_format" type="string">
  The encoding of the bytes in `data[].b64_json` (for example `png`). Populated on the fal-served branch; absent on the OpenAI-served one, where the caller's requested `output_format` is authoritative.
</ResponseField>

<ResponseField name="quality" type="string">
  The quality tier the generation actually ran at. Populated on the fal-served branch when it can resolve one; absent otherwise.
</ResponseField>

<ResponseField name="size" type="string">
  The pixel dimensions the generation actually ran at, as `<width>x<height>`. Populated on the fal-served branch when it can resolve one; absent otherwise.
</ResponseField>

## Examples

### Input

```json theme={null}
{
  "n": 1,
  "prompt": "a red circle",
  "quality": "low",
  "size": "1024x1024"
}
```

### Output

```json theme={null}
{
  "created": 1767225600,
  "data": [
    {
      "b64_json": "PGJhc2U2ND4="
    }
  ],
  "usage": {
    "input_tokens": 12,
    "output_tokens": 1056,
    "total_tokens": 1068
  }
}
```

## 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](/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/models">
    Find models, inspect schemas, and retry safely.
  </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>