> ## 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 で Krea 3 を使用する

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

`krea/krea-3` のAPIリファレンスです。Comfy Router が Krea から提供しています。

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

## クイックスタート

[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:** `krea/krea-3`

**エンドポイント:** `POST https://api.comfy.org/v2/models/krea/krea-3`

> [tab] 結果を待つ
>
> ```python Python theme={null}
> from comfy_sdk import Comfy
>
> # 環境変数から COMFY_API_KEY を読み取ります。
> # SDK は自動的に冪等性キーを作成し、自動再試行のために再利用します。
> with Comfy() as client:
>     result = client.models.run(
>         "krea/krea-3",
>         {
>             "prompt": "A ceramic coffee mug on a clean studio background",
>             "resolution": "1k",
>         },
>     )
>
> print(result)
> ```
>
> ```typescript TypeScript theme={null}
> import { comfy } from "@comfyorg/sdk";
>
> // 環境変数から COMFY_API_KEY を読み取ります。
> // SDK は自動的に冪等性キーを作成し、自動再試行のために再利用します。
> const { data } = await comfy.models.run("krea/krea-3", {
>   prompt: "A ceramic coffee mug on a clean studio background",
>   resolution: "1k",
> });
>
> console.log(data);
> ```
>
> ```bash cURL theme={null}
> curl https://api.comfy.org/v2/models/krea/krea-3 \
>   -H "X-API-Key: $COMFY_API_KEY" \
>   -H "Idempotency-Key: $(uuidgen)" \
>   -H "Content-Type: application/json" \
>   -d "{\"prompt\": \"A ceramic coffee mug on a clean studio background\", \"resolution\": \"1k\"}"
> ```

> [tab] キューに送信して後で取得
>
> 同じボディを `POST https://api.comfy.org/v2/models/krea/krea-3/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(
>             "krea/krea-3",
>             {
>                 "prompt": "A ceramic coffee mug on a clean studio background",
>                 "resolution": "1k",
>             },
>         )
>         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("krea/krea-3", {
>   prompt: "A ceramic coffee mug on a clean studio background",
>   resolution: "1k",
> });
> 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/krea/krea-3/requests \
>   -H "X-API-Key: $COMFY_API_KEY" \
>   -H "Idempotency-Key: $(uuidgen)" \
>   -H "Content-Type: application/json" \
>   -d "{\"prompt\": \"A ceramic coffee mug on a clean studio background\", \"resolution\": \"1k\"}"
>
> # 2. ステータスが COMPLETED になるまでポーリングし、各レスポンスが示す Retry-After 秒だけ待機します。
> REQUEST_ID="<request_id from the 201 body>"
> curl -i https://api.comfy.org/v2/models/krea/krea-3/requests/$REQUEST_ID/status \
>   -H "X-API-Key: $COMFY_API_KEY"
>
> # 3. 取得します。モデルのネイティブ出力を伴う 200、まだ実行中の場合はステータスボディを伴う 202 を返します。
> curl https://api.comfy.org/v2/models/krea/krea-3/requests/$REQUEST_ID \
>   -H "X-API-Key: $COMFY_API_KEY"
> ```

## スキーマ

### 入力

**aspect\_ratio** `string`

1:1、4:5、3:4、2:3、9:16、5:4、4:3、3:2、16:9、21:9。解像度と併用します。自動フレーミングにする場合は省略します。

**image\_urls** `string[]`

入力画像URL。最大8件です。8件を超えるエントリは取得を行う前に拒否されます（/proxy/krea では 400、Comfy Router のスキーマチェックは先に 422 を返します）。画像を POST /proxy/krea/assets にアップロードしたときに返される image\_url（multipart フォームのフィールド `file`）は常に受け付けられます。その他の公開 https URL が受け付けられるかどうかは環境によって異なります。受け付けられない環境では、ホスト app-uploads.krea.ai 上の https URL 以外のリンクはすべて 400 で拒否され、'image\_urls must be image\_url values returned by POST /proxy/krea/assets' と表示されるため、代わりに画像をアップロードしてください。受け付けられる環境では、公開されている https の画像URLはすべて受け付けられ、形式が不正な URL や https でない URL は 400 で拒否されます（ポートが数値でも範囲外である URL はこのチェックでは捕捉されず、代わりに 502 で失敗することがあります）。その場合、app-uploads.krea.ai へのリンクではない image\_urls のエントリ（公開 https URL、またはそれらが受け付けられる環境では base64 の data: URI）を含むリクエストも、取得を行う前に 400 で拒否されます。ただし、リクエストボディ全体が multipart ではなく application/json として送信され、有効な UTF-8 であり、25100288 バイト以下で、このスキーマが宣言するフィールドのみを含む場合は除きます。その場合、形式が正しい https URL については、呼び出し側が修正できる参照はそのホスト名を示して 400 で拒否されます。具体的には、取得前のチェックでホストが解決できない、または公開的に到達できない、許可された回数を超えてリダイレクトする、https でない URL や公開的に到達できないホストへリダイレクトする、408 と 429 以外の 4xx を返す、画像ではない、読み取れない形式の画像である、画像サイズヘッダーが最初の 2 MiB 以内にない、あるいは宣言された長さもチャンクエンコーディングもないレスポンスが画像サイズヘッダーより前に終了する、といった場合です。それ以外の取得時の失敗は、POST /proxy/krea で 502 エラーになります（Comfy Router は 500 internal\_error で応答します）。一時的な DNS、TLS、接続の失敗、タイムアウト、配信元の 408、429、5xx その他の 200 以外のステータス、あるいはチェックは通過したものの取得時の接続で解決できない、または公開的に到達できないホストなどです。これらの一部は再試行で解消します（リゾルバーのエラー、タイムアウト、切断された接続、5xx、408、429 を返す配信元、ホストチェックと接続の間に DNS の応答が非公開アドレスに切り替わるホストなどで、再試行すると成功するか、非公開ホストに対する 400 になることがあります）。一方、毎回同じように失敗するものもあります。たとえば、取得が信頼しない TLS 証明書（自己署名、期限切れ、ホスト名の不一致）、200 以外の 2xx や取得が追従しない 3xx（204、206、300、304、305、Location のない 301、302、303、307、308 など）を返す配信元です。再試行しても同じように失敗する場合は、代わりに画像をアップロードしてください。Comfy Router 経由でキューに入れたリクエストは、image\_urls のいずれかが app-uploads.krea.ai へのリンクでない場合、そのような失敗を再試行しないため、原因が解消しうる場合はご自身で再送信してください。その他の URL が受け付けられない環境では、実際のアップロードではない app-uploads.krea.ai へのリンクは 5xx エラーで失敗します。受け付けられる環境では、他の到達不能な参照と同様に 400 で拒否されます。サーバーがどちらに該当するかをまだ学習していない間は、ホストが app-uploads.krea.ai へのリンクでない https URL は、公開・非公開を問わず、再試行しても安全な 503 エラーで失敗します（キュー中のリクエストは自動的に再試行されます）。キュー中のリクエストの 400 には汎用的な invalid\_input の詳細しか含まれないため、ホスト名も上記の文言も示されず、キューはそれを再試行しません。キュー中の 400 は image\_urls だけでなく任意のフィールド（たとえば未対応の解像度や thinking\_mode）に起因する可能性があるため、まず他のフィールドを確認してください。それらが有効であれば、各画像を POST /proxy/krea/assets にアップロードし、その image\_url の値と新しい Idempotency-Key（またはなし）で再送信してください。ボディを変更して同じキーを再利用すると 409 invalid\_input で拒否され、画像に関する情報は何も示されません。同じボディで再利用すると 201 と元の request\_id、Idempotent-Replayed: true が返るため新しい実行は開始されず、その結果 URL は同じ 400 を返します（ステータス URL は error\_type invalid\_input とともに 200 を返します）。他の公開 https URL が受け付けられる環境で、その再送信も 400 で失敗する場合、問題は画像自体にあります（たとえば未対応の画像である、画像サイズヘッダーが最初の 2 MiB 以内にない、など）。受け付けられない環境では、同じアップロード済み画像はその 400 の代わりに 5xx（Comfy Router では 500 internal\_error）で失敗し、やはり問題は画像にあるため、再度アップロードしても解決しません。各画像のサイズを見つけるために読み取られるのは最初の 2 MiB だけです。そのため、そのウィンドウ内でサイズ情報を読み取れない画像（たとえば 2 MiB を超える埋め込みメタデータを持つ JPEG、またはパレット PNG で透明度データが、透明度がなければ最初の画像データチャンクの開始位置が 2 MiB を超えたところにあるもの、たとえば 2 MiB を超えるテキストチャンクやカラープロファイルチャンクの後にあるもの）は、アップロード済みかどうかに関係なく、画像サイズヘッダーが最初の 2 MiB 以内にないという 400 で拒否されます。大きなメタデータを除いて保存し直すか、パレット PNG を非パレット PNG として保存してください。国際化されたホストは ASCII（punycode）形式で送信してください。非 ASCII のホスト名は存在しないものとして拒否されます。テキストから画像への生成では省略します。

**model** `string`

berry（デフォルト、品質）または jam（速度）。

**negative\_prompt** `string`

**prompt** `string` *required*

生成する内容。image\_urls を指定する場合は編集の指示となり、何を変更し、何を同じまま保つべきかを記述します。

**regional\_edit** `boolean`

画像の残りの部分を保持するローカル編集を行う場合は true に設定します。model に berry を指定し、image\_urls に少なくとも1つの画像が必要です。

**resolution** `string` *required*

1k または 2k。

**seed** `integer`

**thinking\_mode** `string`

fast（デフォルト）、high、ultra。high と ultra は複雑な編集をより詳細に計画し、時間がかかります。ultra には解像度 2k が必要です。

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

### 出力

**completed\_at** `string (date-time)` *required*

形式: `date-time`

**created\_at** `string (date-time)` *required*

形式: `date-time`

**error** `object`

status が失敗の場合にのみ設定されます。キャンセル済みのジョブには含まれません。

**error.code** `string` *required*

ジョブが失敗した理由: content\_policy、invalid\_request、validation\_failed、model\_unavailable、insufficient\_balance、timeout、auto\_cancelled、provider\_error、internal、node\_app\_node\_failed のいずれかです。不明なコードは internal として扱ってください。

**error.message** `string`

任意。provider\_error と internal の際にプロバイダーが返す自由形式のテキストです。

**error.param** `string`

変更すべきリクエストパラメータ。invalid\_request と validation\_failed の場合に含まれます。

**job\_id** `string (uuid)` *required*

形式: `uuid`

**result** `object` *required*

完了した生成結果です。`KreaJob` と異なり、ここでは null 許容ではありません。`result` に `urls` が含まれないターミナル状態のジョブは Comfy Router のエラーとして応答されるため、`200` には必ずこれが含まれます。

**result.style\_id** `string`

生成ではなく loraTraining ジョブによって設定されます。これらのモデルに対する `200` には `urls` が含まれます。

**result.urls** `string (uri)[]` *required*

生成済みの画像をダウンロード可能なリンクとして示します。`urls` が空の `completed` ジョブは `success_without_output` となり、このドキュメントに到達しないため、少なくとも1つ含まれます。

**status** `string` *required*

このドキュメントでは常に `completed` です。Router が成功として報告するのはこのステータスのみであり、Krea の語彙は大文字小文字を区別せずに照合されます。

取りうる値: `completed`

## 例

### 入力

```json theme={null}
{
  "prompt": "A ceramic coffee mug on a clean studio background",
  "resolution": "1k"
}
```

### 出力

```json theme={null}
{
  "completed_at": "2027-01-01T00:00:37Z",
  "created_at": "2027-01-01T00:00:00Z",
  "job_id": "7f1c2e84-5b90-4a37-8d61-2c0f9ab4e153",
  "result": {
    "urls": [
      "https://example.invalid/krea/krea-2/generated.png"
    ]
  },
  "status": "completed"
}
```

## 出荷前の確認

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.