> ## 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 で Patina を使う

> Comfy Router を通して fal/patina を呼び出す: エンドポイント、リクエストの形状、Router が返すレスポンス。

`fal/patina` の API リファレンス。fal から Comfy Router が提供します。

## クイックスタート

[お使いの 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 のスニペットは、同じ呼び出しを raw HTTP で行うものです。

**モデル ID:** `fal/patina`

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

<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(
              "fal/patina",
              {
                  "image_url": "https://storage.googleapis.com/falserverless/gallery/patina-blog-hero-render.png",
              },
          )

      print(result)
      ```

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

      // 環境変数から COMFY_API_KEY を読み取ります。
      // SDK は冪等性キーを自動的に作成し、自動再試行のために再利用します。
      const { data } = await comfy.models.run("fal/patina", {
        image_url: "https://storage.googleapis.com/falserverless/gallery/patina-blog-hero-render.png",
      });

      console.log(data);
      ```

      ```bash cURL theme={null}
      curl https://api.comfy.org/v2/models/fal/patina \
        -H "X-API-Key: $COMFY_API_KEY" \
        -H "Idempotency-Key: $(uuidgen)" \
        -H "Content-Type: application/json" \
        -d "{\"image_url\": \"https://storage.googleapis.com/falserverless/gallery/patina-blog-hero-render.png\"}"
      ```
    </CodeGroup>
  </Tab>

  <Tab title="キューに送信して後で収集する">
    同じ本文を `POST https://api.comfy.org/v2/models/fal/patina/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(
                  "fal/patina",
                  {
                      "image_url": "https://storage.googleapis.com/falserverless/gallery/patina-blog-hero-render.png",
                  },
              )
              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("fal/patina", {
        image_url: "https://storage.googleapis.com/falserverless/gallery/patina-blog-hero-render.png",
      });
      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/fal/patina/requests \
        -H "X-API-Key: $COMFY_API_KEY" \
        -H "Idempotency-Key: $(uuidgen)" \
        -H "Content-Type: application/json" \
        -d "{\"image_url\": \"https://storage.googleapis.com/falserverless/gallery/patina-blog-hero-render.png\"}"

      # 2. status が COMPLETED になるまでポーリングし、各レスポンスが指定する Retry-After 秒だけ待機します。
      REQUEST_ID="<request_id from the 201 body>"
      curl -i https://api.comfy.org/v2/models/fal/patina/requests/$REQUEST_ID/status \
        -H "X-API-Key: $COMFY_API_KEY"

      # 3. 収集。モデルのネイティブ出力とともに 200、まだ実行中ならステータス本文とともに 202。
      curl https://api.comfy.org/v2/models/fal/patina/requests/$REQUEST_ID \
        -H "X-API-Key: $COMFY_API_KEY"
      ```
    </CodeGroup>
  </Tab>
</Tabs>

## スキーマ

### 入力

<ParamField body="enable_safety_checker" type="boolean" default="true">
  画像の安全チェッカーを有効にします。
</ParamField>

<ParamField body="image_url" type="string" required>
  入力画像（写真またはレンダリング）の URL。
</ParamField>

<ParamField body="maps" type="string[]" default="[&#x22;basecolor&#x22;,&#x22;normal&#x22;,&#x22;roughness&#x22;,&#x22;metalness&#x22;,&#x22;height&#x22;]">
  予測する PBR マップ。デフォルトでは 5 つすべてです。
</ParamField>

<ParamField body="output_format" type="string" default="&#x22;png&#x22;">
  出力画像のフォーマット: jpeg、png、webp のいずれか。
</ParamField>

<ParamField body="seed" type="integer">
  再現可能な denoise のためのランダムシード。
</ParamField>

<ParamField body="sync_mode" type="boolean" default="false">
  true の場合、CDN の URL ではなくデータ URI として画像を返します。
</ParamField>

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

### 出力

<ResponseField name="images" type="object[]">
  生成されたタイル状テクスチャ画像と、予測された PBR マテリアルマップ。ベーステクスチャには url のみが含まれ、各マップのエントリには map\_type も含まれます。
</ResponseField>

<ResponseField name="images[].map_type" type="string">
  PBR マップの種類（basecolor、normal、roughness、metalness、height）。ベーステクスチャ画像の場合には存在しません。
</ResponseField>

<ResponseField name="images[].url" type="string">
  生成された画像の URL。
</ResponseField>

<ResponseField name="prompt" type="string">
  テクスチャ生成に使用されたプロンプト（展開されている場合があります）。
</ResponseField>

<ResponseField name="seed" type="integer">
  テクスチャ生成に使用されたシード。
</ResponseField>

<ResponseField name="timings" type="object">
  エンドツーエンドの所要時間の内訳（秒）。
</ResponseField>

## 例

### 入力

```json theme={null}
{
  "image_url": "https://storage.googleapis.com/falserverless/gallery/patina-blog-hero-render.png"
}
```

### 出力

```json theme={null}
{
  "images": [
    {
      "map_type": "basecolor",
      "url": "https://example.invalid/fal/patina/basecolor.png"
    },
    {
      "map_type": "normal",
      "url": "https://example.invalid/fal/patina/normal.png"
    },
    {
      "map_type": "roughness",
      "url": "https://example.invalid/fal/patina/roughness.png"
    }
  ],
  "prompt": "weathered copper roof tiles",
  "seed": 1234567,
  "timings": {
    "inference": 6.25
  }
}
```

## 出荷前の確認

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>