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

# Comfy Router で Photon 1 を使用する

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

`luma/photon-1` の API リファレンスです。Comfy Router が Luma から提供しています。

## クイックスタート

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

**モデル ID:** `luma/photon-1`

**エンドポイント:** `POST https://api.comfy.org/v2/models/luma/photon-1`

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

      # 環境変数から COMFY_API_KEY を読み取ります。
      # SDK は冪等性キーを自動的に作成し、自動リトライのために再利用します。
      with Comfy() as client:
          result = client.models.run(
              "luma/photon-1",
              {
                  "aspect_ratio": "1:1",
                  "prompt": "a red circle 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("luma/photon-1", {
        aspect_ratio: "1:1",
        prompt: "a red circle on a plain white background",
      });

      console.log(data);
      ```

      ```swift Swift theme={null}
      import Foundation
      import ComfySwiftSDK

      // 環境変数から COMFY_API_KEY を読み取ります。
      // SDK は呼び出しごとに冪等性キーを発行し、自動リトライのために再利用します。
      let client = ComfyCloudClient(apiKey: ProcessInfo.processInfo.environment["COMFY_API_KEY"]!)
      let result = try await client.models.run(
          "luma/photon-1",
          input: [
              "aspect_ratio": "1:1",
              "prompt": "a red circle on a plain white background",
          ]
      )

      print(result.output)
      ```

      ```bash cURL theme={null}
      curl https://api.comfy.org/v2/models/luma/photon-1 \
        -H "X-API-Key: $COMFY_API_KEY" \
        -H "Idempotency-Key: $(uuidgen)" \
        -H "Content-Type: application/json" \
        -d "{\"aspect_ratio\": \"1:1\", \"prompt\": \"a red circle on a plain white background\"}"
      ```
    </CodeGroup>
  </Tab>

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

    <CodeGroup>
      ```python Python theme={null}
      from comfy_sdk import Comfy

      # 環境変数から COMFY_API_KEY を読み取ります。
      # submit() の各呼び出しは独自の Idempotency-Key を発行し、自動リトライのために再利用します。
      with Comfy() as client:
          handle = client.models.submit(
              "luma/photon-1",
              {
                  "aspect_ratio": "1:1",
                  "prompt": "a red circle on a plain white background",
              },
          )
          print("request_id:", handle.request_id)  # モデル ID と合わせれば、別のプロセスに必要なものはこれだけです

          # リクエストが完了するまでポーリングし、サーバーが指定する Retry-After の時間だけ待機します。
          for update in handle.iter_events():
              print(update.status, update.queue_position)

          # プロバイダー自身のペイロードで、models.run() が返す値と同じものです。
          # 失敗またはキャンセルされたリクエストは、ここで型付きの Router エラーを発生させます。
          result = handle.get()

      print(result)
      ```

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

      // 環境変数から COMFY_API_KEY を読み取ります。
      // submit() の各呼び出しは独自の Idempotency-Key を発行し、自動リトライのために再利用します。
      const handle = await comfy.models.submit("luma/photon-1", {
        aspect_ratio: "1:1",
        prompt: "a red circle 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);
      ```

      ```swift Swift theme={null}
      import Foundation
      import ComfySwiftSDK

      // 環境変数から COMFY_API_KEY を読み取ります。
      // submit() の各呼び出しは独自の Idempotency-Key を発行し、自動リトライのために再利用します。
      let client = ComfyCloudClient(apiKey: ProcessInfo.processInfo.environment["COMFY_API_KEY"]!)
      let handle = try await client.models.submit(
          "luma/photon-1",
          input: [
              "aspect_ratio": "1:1",
              "prompt": "a red circle on a plain white background",
          ]
      )
      print("requestId:", handle.requestId)  // モデル ID と合わせれば、別のプロセスに必要なものはこれだけです

      // リクエストが完了するまでポーリングし、サーバーが指定する Retry-After の時間だけ待機します。
      for try await update in handle.events() {
          print(update.state.rawValue, update.queuePosition.map(String.init) ?? "unknown")
      }

      // プロバイダー自身のペイロードで、models.run() が返す値と同じものです。
      // 失敗またはキャンセルされたリクエストは、ここで型付きの Router エラーをスローします。
      let result = try await handle.result()

      print(result.output)
      ```

      ```bash cURL theme={null}
      # 1. 送信。Router は request_id、status_url、response_url、cancel_url とともに 201 を返します。
      curl https://api.comfy.org/v2/models/luma/photon-1/requests \
        -H "X-API-Key: $COMFY_API_KEY" \
        -H "Idempotency-Key: $(uuidgen)" \
        -H "Content-Type: application/json" \
        -d "{\"aspect_ratio\": \"1:1\", \"prompt\": \"a red circle 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/luma/photon-1/requests/$REQUEST_ID/status \
        -H "X-API-Key: $COMFY_API_KEY"

      # 3. 収集。まだ実行中であればステータスボディとともに 202、完了していればモデル本来の出力とともに 200 を返します。
      curl https://api.comfy.org/v2/models/luma/photon-1/requests/$REQUEST_ID \
        -H "X-API-Key: $COMFY_API_KEY"
      ```
    </CodeGroup>
  </Tab>
</Tabs>

## スキーマ

### 入力

<ParamField body="aspect_ratio" type="string" default="&#x22;16:9&#x22;">
  生成のアスペクト比

  指定可能な値: `1:1`、`16:9`、`9:16`、`4:3`、`3:4`、`21:9`、`9:21`
</ParamField>

<ParamField body="callback_url" type="string (uri)">
  生成のコールバック URL

  形式: `uri`
</ParamField>

<ParamField body="character_ref" type="object" />

<ParamField body="character_ref.identity0" type="object">
  画像 identity オブジェクト
</ParamField>

<ParamField body="character_ref.identity0.images" type="string (uri)[]">
  画像 identity の URL
</ParamField>

<ParamField body="generation_type" type="string" default="&#x22;image&#x22;">
  指定可能な値: `image`
</ParamField>

<ParamField body="image_ref" type="object[]">
  画像参照オブジェクト
</ParamField>

<ParamField body="image_ref[].url" type="string (uri)">
  画像参照の URL

  形式: `uri`
</ParamField>

<ParamField body="image_ref[].weight" type="number">
  画像参照の重み
</ParamField>

<ParamField body="model" type="string">
  生成に使用する画像モデル。Comfy Router のルート `POST /v2/models/luma/{model}` では、このフィールドはパスから供給されるため送信してはいけません。v1 の `POST /proxy/luma/generations/image` ルートでは、LumaImageModel enum（`photon-1`、`photon-flash-1`）に制約され、Rewrite は省略されたモデルや不明なモデルを拒否することでこれを強制します。
</ParamField>

<ParamField body="modify_image_ref" type="object">
  modify 画像参照オブジェクト
</ParamField>

<ParamField body="modify_image_ref.url" type="string (uri)">
  画像参照の URL

  形式: `uri`
</ParamField>

<ParamField body="modify_image_ref.weight" type="number">
  modify 画像参照の重み
</ParamField>

<ParamField body="prompt" type="string">
  生成のプロンプト
</ParamField>

<ParamField body="style_ref" type="object[]">
  画像参照オブジェクト
</ParamField>

<ParamField body="style_ref[].url" type="string (uri)">
  画像参照の URL

  形式: `uri`
</ParamField>

<ParamField body="style_ref[].weight" type="number">
  画像参照の重み
</ParamField>

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

### 出力

<ResponseField name="assets" type="object">
  画像生成のアセットです。`image` が結果であり、`video` と `progress_video` はこのステータスルートを共有する Dream Machine の VIDEO オペレーションに属するもので、Luma はこれらを明示的な null としてここに送信します。
</ResponseField>

<ResponseField name="assets.image" type="string (uri)">
  生成された画像の URL です。`luma/photon-*` の生成が埋める末端の値にあたります。生成が `completed` に達するまで null です。

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

<ResponseField name="assets.progress_video" type="string (uri)">
  画像生成では常に null です。これは VIDEO 生成の実行中に Luma が公開する進行中のプレビューです。

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

<ResponseField name="assets.video" type="string (uri)">
  画像生成では常に null です。代わりに `luma/ray-*` のビデオモデルがこれを埋めます。

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

<ResponseField name="created_at" type="string (date-time)">
  生成が作成された日時

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

<ResponseField name="failure_reason" type="string">
  生成の状態の理由
</ResponseField>

<ResponseField name="generation_type" type="string">
  生成のタイプです。このオペレーションでは常に `image` です

  取り得る値: `image`
</ResponseField>

<ResponseField name="id" type="string (uuid)">
  生成の ID

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

<ResponseField name="model" type="string">
  生成に使用されたモデル
</ResponseField>

<ResponseField name="request" type="object">
  画像生成リクエストで、ターミナルドキュメント内にエコーバックされたものです。Luma はリクエストモデルのすべてのフィールドをシリアライズし、呼び出し元が設定しなかった各フィールドには明示的な `null` を書き込むため、フィールドの存在はキーではなくその値から読み取ってください。
</ResponseField>

<ResponseField name="request.aspect_ratio" type="string" default="&#x22;16:9&#x22;">
  生成のアスペクト比

  取り得る値: `1:1`, `16:9`, `9:16`, `4:3`, `3:4`, `21:9`, `9:21`
</ResponseField>

<ResponseField name="request.callback_url" type="string (uri)">
  生成のコールバック URL

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

<ResponseField name="request.character_ref" type="object" />

<ResponseField name="request.character_ref.identity0" type="object">
  ターミナルドキュメント内に返ってくる際の画像アイデンティティです。`LumaImageIdentity` と同じ形状で、`LumaImageRefEcho` が示す理由によりそのメンバーは null 許容です。
</ResponseField>

<ResponseField name="request.character_ref.identity0.images" type="string (uri)[]">
  画像アイデンティティの URL
</ResponseField>

<ResponseField name="request.generation_type" type="string">
  設定されている場合は常に `image` で、オペレーションをエコーします。呼び出し元が送信しなかった場合は null です。これはこのエコーオブジェクト全体が存在する理由と同じです。
</ResponseField>

<ResponseField name="request.image_ref" type="object[]">
  ターミナルドキュメント内に返ってくる際の画像参照です。`LumaImageRef` と同じ形状で、Luma は未設定のものを省略せず明示的な `null` としてエコーするため、各メンバーは null 許容です。
</ResponseField>

<ResponseField name="request.image_ref[].url" type="string (uri)">
  画像参照の URL

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

<ResponseField name="request.image_ref[].weight" type="number">
  画像参照の重み
</ResponseField>

<ResponseField name="request.model" type="string" default="&#x22;photon-1&#x22;">
  生成に使用された画像モデル

  取り得る値: `photon-1`, `photon-flash-1`
</ResponseField>

<ResponseField name="request.modify_image_ref" type="object">
  ターミナルドキュメント内に返ってくる際の画像変更参照です。`LumaModifyImageRef` と同じ形状で、`LumaImageRefEcho` が示す理由によりそのメンバーは null 許容です。
</ResponseField>

<ResponseField name="request.modify_image_ref.url" type="string (uri)">
  画像参照の URL

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

<ResponseField name="request.modify_image_ref.weight" type="number">
  画像変更参照の重み
</ResponseField>

<ResponseField name="request.prompt" type="string">
  生成のプロンプト
</ResponseField>

<ResponseField name="request.style_ref" type="object[]">
  ターミナルドキュメント内に返ってくる際の画像参照です。`LumaImageRef` と同じ形状で、Luma は未設定のものを省略せず明示的な `null` としてエコーするため、各メンバーは null 許容です。
</ResponseField>

<ResponseField name="request.style_ref[].url" type="string (uri)">
  画像参照の URL

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

<ResponseField name="request.style_ref[].weight" type="number">
  画像参照の重み
</ResponseField>

<ResponseField name="state" type="string">
  生成の状態

  取り得る値: `queued`, `dreaming`, `completed`, `failed`
</ResponseField>

## 例

### 入力

```json theme={null}
{
  "aspect_ratio": "1:1",
  "prompt": "a red circle on a plain white background"
}
```

### 出力

```json theme={null}
{
  "assets": {
    "image": "https://example.invalid/luma/photon-1/generated.png",
    "progress_video": null,
    "video": null
  },
  "created_at": "2027-01-01T00:00:00Z",
  "failure_reason": null,
  "generation_type": "image",
  "id": "5e8b06d7-91c4-4a2f-8b3d-6f7a8b9c0d1e",
  "model": "photon-1",
  "request": {
    "aspect_ratio": "1:1",
    "callback_url": null,
    "character_ref": null,
    "generation_type": "image",
    "image_ref": null,
    "model": "photon-1",
    "modify_image_ref": null,
    "prompt": "a red circle on a plain white background",
    "style_ref": null
  },
  "state": "completed"
}
```

## 出荷前の確認

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>