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

# Comfy Router で Gen 4 Image を使用する

> Comfy Router 経由で runway/gen4_image を呼び出します: エンドポイント、リクエストの形状、Router が返すレスポンスについて説明します。

`runway/gen4_image` の API リファレンスです。Comfy Router が Runway から提供します。

## クイックスタート

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

**モデル ID:** `runway/gen4_image`

**エンドポイント:** `POST https://api.comfy.org/v2/models/runway/gen4_image`

<Tabs>
  <Tab title="Wait for the result">
    <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(
              "runway/gen4_image",
              {
                  "promptText": "a red circle",
                  "ratio": "1024:1024",
              },
          )

      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("runway/gen4_image", {
        promptText: "a red circle",
        ratio: "1024:1024",
      });

      console.log(data);
      ```

      ```bash cURL theme={null}
      curl https://api.comfy.org/v2/models/runway/gen4_image \
        -H "X-API-Key: $COMFY_API_KEY" \
        -H "Idempotency-Key: $(uuidgen)" \
        -H "Content-Type: application/json" \
        -d "{\"promptText\": \"a red circle\", \"ratio\": \"1024:1024\"}"
      ```
    </CodeGroup>
  </Tab>

  <Tab title="Queue and collect later">
    <CodeGroup>
      ```python Python theme={null}
      from comfy_sdk import Comfy

      # Reads COMFY_API_KEY from the environment.
      # Each submit() call mints its own Idempotency-Key and reuses it for automatic retries.
      with Comfy() as client:
          handle = client.models.submit(
              "runway/gen4_image",
              {
                  "promptText": "a red circle",
                  "ratio": "1024:1024",
              },
          )
          print("request_id:", handle.request_id)  # with the model ID, all another process needs

          # Poll until the request completes, waiting the Retry-After the server names.
          for update in handle.iter_events():
              print(update.status, update.queue_position)

          # The provider's own payload, the same value models.run() returns.
          # A request that failed or was cancelled raises the typed Router error here.
          result = handle.get()

      print(result)
      ```

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

      // Reads COMFY_API_KEY from the environment.
      // Each submit() call mints its own Idempotency-Key and reuses it for automatic retries.
      const handle = await comfy.models.submit("runway/gen4_image", {
        promptText: "a red circle",
        ratio: "1024:1024",
      });
      console.log("requestId:", handle.requestId); // with the model ID, all another process needs

      // Poll until the request completes, waiting the Retry-After the server names.
      for await (const update of handle.events()) {
        console.log(update.status, update.queuePosition);
      }

      // The same result models.run() returns. A request that failed or was cancelled rejects here.
      const result = await handle.get();

      console.log(result.data);
      ```

      ```bash cURL theme={null}
      # 1. Submit. Router answers 201 with request_id, status_url, response_url and cancel_url.
      curl https://api.comfy.org/v2/models/runway/gen4_image/requests \
        -H "X-API-Key: $COMFY_API_KEY" \
        -H "Idempotency-Key: $(uuidgen)" \
        -H "Content-Type: application/json" \
        -d "{\"promptText\": \"a red circle\", \"ratio\": \"1024:1024\"}"

      # 2. Poll until status is COMPLETED, waiting the Retry-After seconds each response names.
      REQUEST_ID="<request_id from the 201 body>"
      curl -i https://api.comfy.org/v2/models/runway/gen4_image/requests/$REQUEST_ID/status \
        -H "X-API-Key: $COMFY_API_KEY"

      # 3. Collect. 200 with the model's native output, 202 with the status body while it is still running.
      curl https://api.comfy.org/v2/models/runway/gen4_image/requests/$REQUEST_ID \
        -H "X-API-Key: $COMFY_API_KEY"
      ```
    </CodeGroup>
  </Tab>
</Tabs>

## スキーマ

### 入力

<ParamField body="model" type="string">
  生成に使用するモデル。Comfy Router のルート `POST /v2/models/runway/{model}` では、このフィールドはパスから供給されるため送信してはいけません。v1 の `POST /proxy/runway/text_to_image` ルートでは必須で、`gen4_image` に制約されています。
</ParamField>

<ParamField body="promptText" type="string" required>
  画像生成用のテキストプロンプト
</ParamField>

<ParamField body="ratio" type="string" required>
  指定可能な値: `1920:1080`、`1080:1920`、`1024:1024`、`1360:768`、`1080:1080`、`1168:880`、`1440:1080`、`1080:1440`、`1808:768`、`2112:912`
</ParamField>

<ParamField body="referenceImages" type="object[]">
  生成をガイドする参照画像の配列
</ParamField>

<ParamField body="referenceImages[].uri" type="string" required>
  エンコードされた画像を含む HTTPS URL またはデータ URI
</ParamField>

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

### 出力

<ResponseField name="createdAt" type="string (date-time)" required>
  タスク作成タイムスタンプ

  フォーマット: `date-time`
</ResponseField>

<ResponseField name="id" type="string" required>
  タスク ID
</ResponseField>

<ResponseField name="output" type="string[]">
  完了した生成のアセット URL。`runway/gen4_image` の場合、各要素は画像 URL です。タスクが正常に終了すると含まれます。このリストが結果そのものです。
</ResponseField>

<ResponseField name="progress" type="number">
  タスクの進捗を表す 0 から 1 の間の浮動小数点値。status が RUNNING の場合にのみ利用可能です。

  範囲: `0` から `1`

  フォーマット: `float`
</ResponseField>

<ResponseField name="status" type="string" required>
  Runway タスクで指定可能なステータス。

  指定可能な値: `SUCCEEDED`、`RUNNING`、`FAILED`、`PENDING`、`CANCELLED`、`THROTTLED`
</ResponseField>

## 例

### 入力

```json theme={null}
{
  "promptText": "a red circle",
  "ratio": "1024:1024"
}
```

### 出力

```json theme={null}
{
  "createdAt": "2027-01-01T00:00:00Z",
  "id": "5f7c1b28-9a03-4e61-8d2f-1b2c3d4e5f60",
  "output": [
    "https://example.invalid/runway/gen4_image/generated.png"
  ],
  "status": "SUCCEEDED"
}
```

## 出荷前の確認

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

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

<CardGroup cols={3}>
  <Card title="ヘッダー" icon="list" href="/ja/development/comfy-router/quickstart">
    認証、冪等性、リクエスト ID、エラー分類、リトライ間隔、支出上限。
  </Card>

  <Card title="Router API の利用" icon="code" href="/ja/development/comfy-router/quickstart">
    モデルの検出、バリデーションエラー、リトライ、課金。
  </Card>

  <Card title="制限事項" icon="triangle-exclamation" href="/ja/development/comfy-router/limitations">
    Router が現在対応していないことと、代替手段。
  </Card>
</CardGroup>