> ## 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.

# Grok Imagine Image Pro を Comfy Router で使用する

> Comfy Router 経由で xai/grok-imagine-image-pro を呼び出す: エンドポイント、リクエストの形状、Router が返すレスポンス。

xAI から Comfy Router によって提供される `xai/grok-imagine-image-pro` の API リファレンスです。

**入力：** 画像、テキスト · **出力：** 画像

> [!WARNING]
>
> xAI は [2026 年 5 月 15 日](https://docs.x.ai/developers/migration/may-15-retirement) に `grok-imagine-image-pro` を廃止し、そのリクエストを `grok-imagine-image-quality` にルーティングしました。続いて xAI は 2026 年 11 月 2 日に `grok-imagine-image-quality` を廃止しました。リクエストは現在、`grok-imagine-image-2.0` が低品質で処理します。詳細は [xAI の移行に関するお知らせ](https://docs.x.ai/developers/migration/imagine-image-quality-nov-2) を参照してください。

## クイックスタート

[Comfy ワークスペース](https://platform.comfy.org/profile/api-keys?onboarding=router)でキーを作成し、`COMFY_API_KEY` としてエクスポートします。Python と TypeScript のスニペットは Comfy SDK（`pip install comfy-sdk` および `npm install @comfyorg/sdk`）を使用しています。cURL スニペットは、生の HTTP 経由で同じ呼び出しを行います。

**モデル ID:** `xai/grok-imagine-image-pro`

**エンドポイント:** `POST https://api.comfy.org/v2/models/xai/grok-imagine-image-pro`

> [tab] 結果を待つ
>
> ```python Python theme={null}
> from comfy_sdk import Comfy
>
> # 環境変数から COMFY_API_KEY を読み取ります。
> # SDK は自動的に冪等性キーを作成し、自動リトライで再利用します。
> with Comfy() as client:
>     result = client.models.run(
>         "xai/grok-imagine-image-pro",
>         {
>             "n": 1,
>             "prompt": "A single red maple leaf on a plain white background.",
>         },
>     )
>
> print(result)
> ```
>
> ```typescript TypeScript theme={null}
> import { comfy } from "@comfyorg/sdk";
>
> // 環境変数から COMFY_API_KEY を読み取ります。
> // SDK は自動的に冪等性キーを作成し、自動リトライで再利用します。
> const { data } = await comfy.models.run("xai/grok-imagine-image-pro", {
>   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-pro \
>   -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.\"}"
> ```

> [tab] キューに送信して後で収集
>
> 同じボディを `POST https://api.comfy.org/v2/models/xai/grok-imagine-image-pro/requests` に送信します。実行が受け付けられるとすぐに Router が `201` と `request_id` を返し、結果は準備ができた時点で、このプロセスからでも別のプロセスからでも収集できます。[キューの配信](https://docs.comfy.org/ja/development/comfy-router/queue.md)では、ステータス、キャンセル、収集について説明します。
>
> ```python Python theme={null}
> import asyncio
> from comfy_sdk import AsyncComfy
>
> # 環境変数から COMFY_API_KEY を読み取ります。
> # 各 submit() 呼び出しは独自の Idempotency-Key を生成し、自動リトライのために再利用します。
> async def main():
>     async with AsyncComfy() as client:
>         handle = await client.models.submit(
>             "xai/grok-imagine-image-pro",
>             {
>                 "n": 1,
>                 "prompt": "A single red maple leaf on a plain white background.",
>             },
>         )
>         print("request_id:", handle.request_id)  # モデル ID と合わせれば、別のプロセスに必要なものはこれだけです
>
>         # リクエストが完了するまでポーリングし、サーバーが指定する Retry-After だけ待機します。
>         async for update in handle.iter_events():
>             print(update.status, update.queue_position)
>
>         # プロバイダー自身のペイロードで、models.run() が返す値と同じものです。
>         # 失敗またはキャンセルされたリクエストは、ここで型付きの Router エラーを送出します。
>         result = await handle.get()
>
>     print(result)
>
> asyncio.run(main())
> ```
>
> ```typescript TypeScript theme={null}
> import { comfy } from "@comfyorg/sdk";
>
> // 環境変数から COMFY_API_KEY を読み取ります。
> // 各 submit() 呼び出しは独自の Idempotency-Key を生成し、自動リトライのために再利用します。
> const handle = await comfy.models.submit("xai/grok-imagine-image-pro", {
>   n: 1,
>   prompt: "A single red maple leaf on a plain white background.",
> });
> console.log("requestId:", handle.requestId); // モデル ID と合わせれば、別のプロセスに必要なものはこれだけです
>
> // リクエストが完了するまでポーリングし、サーバーが指定する Retry-After だけ待機します。
> for await (const update of handle.events()) {
>   console.log(update.status, update.queuePosition);
> }
>
> // models.run() が返すのと同じ結果です。失敗またはキャンセルされたリクエストはここで reject されます。
> const result = await handle.get();
>
> console.log(result.data);
> ```
>
> ```bash cURL theme={null}
> # 1. 送信。Router は request_id、status_url、response_url、cancel_url とともに 201 を返します。
> curl https://api.comfy.org/v2/models/xai/grok-imagine-image-pro/requests \
>   -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.\"}"
>
> # 2. ステータスが COMPLETED になるまでポーリングし、各レスポンスが指定する Retry-After 秒だけ待機します。
> REQUEST_ID="<request_id from the 201 body>"
> curl -i https://api.comfy.org/v2/models/xai/grok-imagine-image-pro/requests/$REQUEST_ID/status \
>   -H "X-API-Key: $COMFY_API_KEY"
>
> # 3. 収集。モデルのネイティブ出力とともに 200、まだ実行中の場合はステータスボディとともに 202 を返します。
> curl https://api.comfy.org/v2/models/xai/grok-imagine-image-pro/requests/$REQUEST_ID \
>   -H "X-API-Key: $COMFY_API_KEY"
> ```

## スキーマ

### 入力

**aspect\_ratio** `string` (default: "auto")

生成される画像のアスペクト比。デフォルトは auto で、プロンプトに最適な比率が自動的に選択されます。

指定可能な値: `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")

使用するモデル。対応: grok-imagine-image（デフォルト）、grok-imagine-image-pro、grok-imagine-image-quality、grok-imagine-image-2.0。非推奨の -beta ID は GA モデルへのエイリアスです。

**n** `integer` (default: 1)

生成する画像の数

範囲: `1` から `10`

**prompt** `string` *required*

画像生成のためのプロンプト

**quality** `string`

出力画像の品質。grok-imagine-image-2.0 では、これが価格ティアを選択します（low、medium、または auto。省略時は xAI のデフォルトで、auto は生成時に low、編集時に medium を使用）。その他のモデルはこれを無視します。

指定可能な値: `low`, `medium`, `high`, `auto`

**resolution** `string` (default: "1k")

生成される画像の解像度。デフォルトは 1k。

指定可能な値: `1k`, `2k`

**response\_format** `string` (default: "url")

画像を返す際のレスポンス形式。url または b64\_json を指定できます。Comfy は送信リクエストでこれを `url` に強制変換します。Comfy Router のディスパッチ（`POST /v2/models/xai/{model}`）でも、この `/proxy/` ルートでも同様です。いずれの場合も画像結果は再ホストされた URL として提供されるためです。そのため enum 内の値は受け入れられたうえで無視されます。`url` か `b64_json` を送っても、フィールドを省略しても、結果は同じです。enum 外の値は（続いて説明する、各経路が認識する UNSET 表記を除き）どちらの経路でも強制変換されずに拒否され、異なるのは拒否の形だけです。この `/proxy/` ルートは受信時に `400` を返し、`POST /v2/models/xai/{model}` の Router ディスパッチは、パートナー呼び出しが行われる前に、ここで公開されている enum に対するフィールド単位の `422` を返します。UNSET と見なされる値は経路ごとに異なります。この `/proxy/` ルートでは、フィールドの省略、明示的な `null`、および `""` はいずれも未設定を意味し、受け入れられる値と同様に強制変換されます。Router ディスパッチは公開されている enum を厳密に適用するため、`null` と `""` は他の非メンバー値と同様に非メンバーです。その経路で未設定のままにするには、フィールドを省略してください。

指定可能な値: `url`, `b64_json`

**size** `string`

画像のサイズ（未対応）

**style** `string`

画像のスタイル（未対応）

**user** `string`

エンドユーザーを表す一意の識別子。xAI が不正利用の監視と検出を行うのに役立ちます

**image** `object`

xAI エンドポイント用の入力画像オブジェクト

**image.type** `string`

画像入力のタイプ

指定可能な値: `image_url`

**image.url** `string` *required*

入力画像の URL（公開 URL または base64 エンコードされたデータ URI）

**images** `object[]`

マルチリファレンス編集用の入力画像のリスト。image とは排他的です。複数の画像を指定する場合、プロンプト内で \<IMAGE\_0>、\<IMAGE\_1> などとして参照します。

**images\[].type** `string`

画像入力のタイプ

指定可能な値: `image_url`

**images\[].url** `string` *required*

入力画像の URL（公開 URL または base64 エンコードされたデータ URI）

**mask** `object`

xAI エンドポイント用の入力画像オブジェクト

**mask.type** `string`

画像入力のタイプ

指定可能な値: `image_url`

**mask.url** `string` *required*

入力画像の URL（公開 URL または base64 エンコードされたデータ URI）

Router が `GET /v2/models/xai/grok-imagine-image-pro/openapi.json` で提供するスキーマから生成されています。これは、リクエストがプロバイダーに到達する前に Router が呼び出しを検証する際に使用するドキュメントと同じものです。

### 出力

**block\_reason** `string`

リクエストが入力モデレーションによってブロックされた場合、ブロック理由を含みます

**data** `object[]`

生成された画像オブジェクトのリスト

**data\[].b64\_json** `string`

生成された画像を jpeg エンコーディングで表した base64 エンコード文字列（response\_format が b64\_json の場合）

**data\[].mime\_type** `string`

生成された画像の MIME タイプ（例: image/png、image/jpeg、image/webp）。

**data\[].url** `string`

生成された画像への URL（response\_format が url の場合）

**usage** `object`

画像生成リクエストの使用量情報

**usage.cost\_in\_usd\_ticks** `integer`

このリクエストの正確なコスト（USD ティック単位、10,000,000,000 ティック = 1 USD）

## 例

### 入力

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

### 出力

```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
  }
}
```

## 出荷前の確認

SDK は `Idempotency-Key` を生成し、自動リトライで再利用します。手動リトライでは元のキーを再利用してください。Router は最大 10 分間接続を保持できます。

リクエストが失敗すると、Router は理由を説明する `X-Comfy-Error-Type` レスポンスヘッダーを送信します。`422` は、プロバイダーを呼び出す前に Router が入力を拒否したことを意味し、`413` はリクエスト本文が Router の受け入れ可能なサイズを超えていたことを意味します。生成されたアセットは [結果 URL の有効期限](https://docs.comfy.org/ja/development/comfy-router/reference.md#結果アセット) があるため、早めにダウンロードしてください。

上記のフィールド説明に記載されているサイズ制限は、プロバイダーの仕様から引用した、そのフィールドに対するプロバイダー自身の上限です。Router はリクエスト本文全体に対して別の上限を適用し、base64 エンコードされたメディアもこれにカウントされます。[リクエスト本文のサイズ](https://docs.comfy.org/ja/development/comfy-router/limitations.md) を参照してください。

このページは、Comfy Router 経由で呼び出す 1 つのパートナーモデルについて説明しています。同じ `comfy-sdk` / `@comfyorg/sdk` パッケージには、Comfy Cloud 上で ComfyUI のワークフローグラフ全体を実行するための 2 つ目のクライアントも含まれています: `Comfy(api_key=...)` / `new Comfy({ apiKey })`、および `client.workflows`、`client.assets`、`client.jobs`。[Comfy SDKs](https://docs.comfy.org/ja/development/api-development/sdks.md) を参照してください。

> [card] [ヘッダー](https://docs.comfy.org/ja/development/comfy-router/headers.md)
>
> 認証、冪等性、リクエスト ID、エラー分類、リトライ間隔、支出上限。

> [card] [Router API の利用](https://docs.comfy.org/ja/development/comfy-router/api.md)
>
> モデルの検出、バリデーションエラー、リトライ、課金。

> [card] [制限事項](https://docs.comfy.org/ja/development/comfy-router/limitations.md)
>
> Router が現在対応していないことと、代替手段。


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.