> ## 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 で AI Image Relight を使う

> Comfy Router を通じて freepik/ai-image-relight を呼び出します: エンドポイント、リクエストの形状、Router が返すレスポンスについて説明します。

`freepik/ai-image-relight` の API リファレンスです。Comfy Router が Freepik から提供しています。

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

## クイックスタート

[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:** `freepik/ai-image-relight`

**エンドポイント:** `POST https://api.comfy.org/v2/models/freepik/ai-image-relight`

> [tab] 結果を待つ
>
> ```python Python theme={null}
> from comfy_sdk import Comfy
>
> # 環境変数から COMFY_API_KEY を読み取ります。
> # SDK は自動的に冪等キーを作成し、自動リトライ時に再利用します。
> with Comfy() as client:
>     result = client.models.run(
>         "freepik/ai-image-relight",
>         {
>             "image": "https://img.magnific.com/free-photo/light-through-mountains_395237-33.jpg?semt=ais_hybrid&w=740&q=80",
>             "prompt": "warm golden-hour sunlight from the left",
>         },
>     )
>
> print(result)
> ```
>
> ```typescript TypeScript theme={null}
> import { comfy } from "@comfyorg/sdk";
>
> // 環境変数から COMFY_API_KEY を読み取ります。
> // SDK は自動的に冪等キーを作成し、自動リトライ時に再利用します。
> const { data } = await comfy.models.run("freepik/ai-image-relight", {
>   image: "https://img.magnific.com/free-photo/light-through-mountains_395237-33.jpg?semt=ais_hybrid&w=740&q=80",
>   prompt: "warm golden-hour sunlight from the left",
> });
>
> console.log(data);
> ```
>
> ```bash cURL theme={null}
> curl https://api.comfy.org/v2/models/freepik/ai-image-relight \
>   -H "X-API-Key: $COMFY_API_KEY" \
>   -H "Idempotency-Key: $(uuidgen)" \
>   -H "Content-Type: application/json" \
>   -d "{\"image\": \"https://img.magnific.com/free-photo/light-through-mountains_395237-33.jpg?semt=ais_hybrid&w=740&q=80\", \"prompt\": \"warm golden-hour sunlight from the left\"}"
> ```

> [tab] キューに送信して後で収集する
>
> 同じ本文を `POST https://api.comfy.org/v2/models/freepik/ai-image-relight/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(
>             "freepik/ai-image-relight",
>             {
>                 "image": "https://img.magnific.com/free-photo/light-through-mountains_395237-33.jpg?semt=ais_hybrid&w=740&q=80",
>                 "prompt": "warm golden-hour sunlight from the left",
>             },
>         )
>         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("freepik/ai-image-relight", {
>   image: "https://img.magnific.com/free-photo/light-through-mountains_395237-33.jpg?semt=ais_hybrid&w=740&q=80",
>   prompt: "warm golden-hour sunlight from the left",
> });
> console.log("requestId:", handle.requestId); // モデル ID と合わせて、別プロセスに必要なのはこれだけです
>
> // リクエストが完了するまでポーリングし、サーバーが指定する Retry-After の時間だけ待機します。
> for await (const update of handle.events()) {
>   console.log(update.status, update.queuePosition);
> }
>
> // models.run() が返すのと同じ結果です。失敗またはキャンセル済みのリクエストは、ここで拒否されます。
> 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/freepik/ai-image-relight/requests \
>   -H "X-API-Key: $COMFY_API_KEY" \
>   -H "Idempotency-Key: $(uuidgen)" \
>   -H "Content-Type: application/json" \
>   -d "{\"image\": \"https://img.magnific.com/free-photo/light-through-mountains_395237-33.jpg?semt=ais_hybrid&w=740&q=80\", \"prompt\": \"warm golden-hour sunlight from the left\"}"
>
> # 2. ステータスが COMPLETED になるまでポーリングし、各レスポンスが指定する Retry-After 秒だけ待機します。
> REQUEST_ID="<request_id from the 201 body>"
> curl -i https://api.comfy.org/v2/models/freepik/ai-image-relight/requests/$REQUEST_ID/status \
>   -H "X-API-Key: $COMFY_API_KEY"
>
> # 3. 収集します。モデル固有の出力とともに 200、まだ実行中の場合はステータス本文とともに 202 を返します。
> curl https://api.comfy.org/v2/models/freepik/ai-image-relight/requests/$REQUEST_ID \
>   -H "X-API-Key: $COMFY_API_KEY"
> ```

## スキーマ

### 入力

**advanced\_settings** `object`

**advanced\_settings.blacks** `integer` (default: 50)

画像の黒のレベルを調整します。

範囲: `0` から `100`

**advanced\_settings.brightness** `integer` (default: 50)

画像の明るさのレベルを調整します。

範囲: `0` から `100`

**advanced\_settings.contrast** `integer` (default: 50)

画像のコントラストのレベルを調整します。

範囲: `0` から `100`

**advanced\_settings.engine** `string` (default: "automatic")

リライト用のエンジンプリセット:

* balanced: バランスの取れた汎用オプション
* cool: より明るくクールな色調
* real: 写真品質の向上を目指します (実験的)
* illusio: イラストや描画に最適化
* fairy: ファンタジーをテーマにした画像に適しています
* colorful\_anime: アニメ、カートゥーン、鮮やかな色に最適
* hard\_transform: オリジナル画像を大きく変化させます
* softy: ややソフトな効果で、グラフィックデザインに適しています

  可能な値: `automatic`, `balanced`, `cool`, `real`, `illusio`, `fairy`, `colorful_anime`, `hard_transform`, `softy`

**advanced\_settings.fixed\_generation** `boolean` (default: false)

有効にすると、同じ設定を使うことで常に同じ画像が生成されます。

**advanced\_settings.saturation** `integer` (default: 50)

画像の彩度のレベルを調整します。

範囲: `0` から `100`

**advanced\_settings.transfer\_light\_a** `string` (default: "automatic")

ライト転送の強度を調整します。

可能な値: `automatic`, `low`, `medium`, `normal`, `high`, `high_on_faces`

**advanced\_settings.transfer\_light\_b** `string` (default: "automatic")

ライト転送の強度も変更します。transfer\_light\_a と組み合わせることで、さまざまな効果が得られます。

可能な値: `automatic`, `composition`, `straight`, `smooth_in`, `smooth_out`, `smooth_both`, `reverse_both`, `soft_in`, `soft_out`, `soft_mid`, `strong_mid`, `style_shift`, `strong_shift`

**advanced\_settings.whites** `integer` (default: 50)

画像の白のレベルを調整します。

範囲: `0` から `100`

**change\_background** `boolean` (default: true)

有効にすると、プロンプトや参照画像に基づいて背景を変更します。商品配置やポートレートに便利です。

**image** `string` *required*

リライト対象の画像の Base64 または URL

**interpolate\_from\_original** `boolean` (default: false)

有効にすると、ライト転送強度スライダーを使って最終画像をオリジナルから補間します。

**light\_transfer\_strength** `integer` (default: 100)

ライト転送の強度レベル。0% はオリジナルに最も近く、100% は最大の転送です。

範囲: `0` から `100`

**preserve\_details** `boolean` (default: true)

オリジナル画像のテクスチャや細部を保持します。商品撮影やテキストなどに適しています。

**prompt** `string`

説明的なプロンプトで生成プロセスを導き、ライト転送に影響を与えることができます。
重要: プロンプト内で括弧と数字 (1 から 1.4) を使うことで、ライトの特定の側面を強調できます。例: "(dark scene:1.3)"

**style** `string` (default: "standard")

リライト操作用のスタイルプリセット。

可能な値: `standard`, `darker_but_realistic`, `clean`, `smooth`, `brighter`, `contrasted_n_hdr`, `just_composition`

**transfer\_light\_from\_lightmap** `string`

ライト転送用ライトマップの Base64 または URL。'transfer\_light\_from\_reference\_image' とは併用できません

**transfer\_light\_from\_reference\_image** `string`

ライト転送用参照画像の Base64 または URL。'transfer\_light\_from\_lightmap' とは併用できません

**webhook\_url** `string (uri)`

タスクのステータスが変わるたびに非同期通知を受け取るためのオプションのコールバック URL。

形式: `uri`

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

### 出力

**data** `object` *required*

**data.generated** `string (uri)[]` *required*

完了した生成の画像 URL。Router が返すドキュメントに含まれ、空にはなりません。このリストが結果そのものです。リンクは Freepik 独自のもので、有効期限があります。

**data.status** `string` *required*

可能な値: `COMPLETED`

**data.task\_id** `string (uuid)`

形式: `uuid`

## 例

### 入力

```json theme={null}
{
  "image": "https://img.magnific.com/free-photo/light-through-mountains_395237-33.jpg?semt=ais_hybrid&w=740&q=80",
  "prompt": "warm golden-hour sunlight from the left"
}
```

### 出力

```json theme={null}
{
  "data": {
    "generated": [
      "https://example.invalid/freepik/ai-image-relight/relit.png"
    ],
    "status": "COMPLETED",
    "task_id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
  }
}
```

## 出荷前の確認

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.