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

# Comfy RouterでRecraft V4を使用する

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

Comfy Router が Recraft から提供する `recraft/recraftv4` の API リファレンスです。

## クイックスタート

[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:** `recraft/recraftv4`

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

<Tabs defaultTabIndex={1}>
  <Tab title="結果を待つ">
    <CodeGroup>
      ```python Python theme={null}
      from comfy_sdk import Comfy

      # 環境変数から COMFY_API_KEY を読み取ります。
      # SDK は自動的に冪等キーを作成し、自動リトライで再利用します。
      with Comfy() as client:
          result = client.models.run(
              "recraft/recraftv4",
              {
                  "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("recraft/recraftv4", {
        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/recraft/recraftv4 \
        -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>
  </Tab>

  <Tab title="キューに入れて後で取得する">
    同じボディを `POST https://api.comfy.org/v2/models/recraft/recraftv4/requests` に送信します。Router は実行が受け付けられ次第 `201` と `request_id` を返し、結果は準備が整った時点で、このプロセスからでも別のプロセスからでも取得できます。ステータス、キャンセル、結果の取得の詳細は [キュー配信](/ja/development/comfy-router/queue) を参照してください。

    <CodeGroup>
      ```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(
                  "recraft/recraftv4",
                  {
                      "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("recraft/recraftv4", {
        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/recraft/recraftv4/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/recraft/recraftv4/requests/$REQUEST_ID/status \
        -H "X-API-Key: $COMFY_API_KEY"

      # 3. 取得。モデルのネイティブ出力とともに 200、まだ実行中の場合はステータスボディとともに 202 を返します。
      curl https://api.comfy.org/v2/models/recraft/recraftv4/requests/$REQUEST_ID \
        -H "X-API-Key: $COMFY_API_KEY"
      ```
    </CodeGroup>
  </Tab>
</Tabs>

## スキーマ

### 入力

<ParamField body="controls" type="object">
  生成する画像のコントロール
</ParamField>

<ParamField body="controls.artistic_level" type="integer">
  画像の芸術的なトーンを定義します。シンプルなレベルでは、人物は静的でクリーンなスタイルでカメラをまっすぐ見ます。ダイナミックおよびエキセントリックなレベルでは、動きと創造性が導入されます。

  範囲: `0` から `5`
</ParamField>

<ParamField body="controls.background_color" type="object">
  RGB の色の値
</ParamField>

<ParamField body="controls.background_color.rgb" type="integer[]" required />

<ParamField body="controls.colors" type="object[]">
  好ましい色の配列
</ParamField>

<ParamField body="controls.colors[].rgb" type="integer[]" required />

<ParamField body="controls.no_text" type="boolean">
  テキストレイアウトを埋め込まない
</ParamField>

<ParamField body="model" type="string">
  生成に使用するモデル（例: "recraftv3"）。このフィールドは enum に制約されません。プロキシは呼び出し元が送信したものをそのまま転送します。Comfy が提供するスペル、つまり Comfy Router が `recraft/<model>` として扱うセットは、recraftv2、recraftv3、recraftv4、recraftv4\_pro、recraftv4\_1、recraftv4\_1\_utility、recraftv4\_1\_pro、recraftv4\_1\_utility\_pro、recraftv4\_styles、recraftv4\_styles\_pro、recraftv4\_1\_vector、recraftv4\_1\_utility\_vector、recraftv4\_1\_pro\_vector、recraftv4\_1\_utility\_pro\_vector、recraftv4\_styles\_vector、recraftv4\_styles\_pro\_vector です。これらを参照で示すのではなくここに直接書き出しているのは、これらを宣言している RecraftGenerationModel コンポーネントが何からも `$ref` されておらず、そのため GET /openapi で提供される spec から削除されているからです。そのため、そこへのポインタは提供されるドキュメント内で宙に浮いてしまいます。4 つの `recraftv4_styles*` のスペルはさらに `style_id` を必要とします。そのフィールドを参照してください。
</ParamField>

<ParamField body="n" type="integer">
  生成する画像の数。Recraft は 1〜6 を受け付けます。

  範囲: `1` から `6`
</ParamField>

<ParamField body="prompt" type="string" required>
  生成する画像を説明するテキストプロンプト
</ParamField>

<ParamField body="response_format" type="string">
  取り得る値: `url`、`b64_json`
</ParamField>

<ParamField body="size" type="string">
  生成済み画像のサイズ（例: "1024x1024"）
</ParamField>

<ParamField body="style" type="string">
  生成済み画像に適用するスタイル（例: "digital\_illustration"）
</ParamField>

<ParamField body="style_id" type="string">
  生成済み画像に適用するスタイル ID（例: "123e4567-e89b-12d3-a456-426614174000"）。style\_id を指定する場合、style は指定しないでください。4 つの `recraftv4_styles*` モデルでは必須です。Recraft は style\_id またはスタイル参照のないものを拒否します。`POST /proxy/recraft/styles` で発行できます。これは同じプロキシが同じ認証情報で提供しています。このルート上ではこの組み合わせを強制するものは何もありません。ボディはそのまま Recraft に転送されるため、これがない `recraftv4_styles*` 呼び出しはパートナーに到達し、4xx が返ります。
</ParamField>

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

### 出力

<ResponseField name="created" type="integer" required>
  生成が作成された Unix タイムスタンプ
</ResponseField>

<ResponseField name="credits" type="integer" required>
  生成に使用されたクレジット数
</ResponseField>

<ResponseField name="data" type="object[]" required>
  生成済み画像情報の配列
</ResponseField>

<ResponseField name="data[].b64_json" type="string">
  Base64 エンコードされた画像データ（リクエストで `response_format: b64_json` を設定した場合、`url` の代わりに存在します）
</ResponseField>

<ResponseField name="data[].image_id" type="string">
  生成済み画像の一意の識別子
</ResponseField>

<ResponseField name="data[].url" type="string">
  生成済み画像にアクセスするための URL（`response_format` が `url` の場合に存在します。これがデフォルトです）
</ResponseField>

<ResponseField name="style_id" type="string">
  解決されたスタイル id。スタイル参照が使用された場合に Recraft から返されます（特に必須入力モデル recraftv4\_styles\* で重要です）。後のリクエストで `style_id` として再利用できます。
</ResponseField>

## 例

### 入力

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

### 出力

```json theme={null}
{
  "created": 1767225600,
  "credits": 1,
  "data": [
    {
      "image_id": "3f7a1b28-5c0d-4e91-8a6f-1b2c3d4e5f60",
      "url": "https://example.invalid/recraft/recraftv3/generated.png"
    }
  ]
}
```

## 出荷前の確認

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

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

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

このページは、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](/ja/development/api-development/sdks) を参照してください。

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

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

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