Comfy Router で GPT Image 2.5 Sunburst を使う

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

OpenAI が提供する openai/gpt-image-2.5-sunburst の API リファレンス。Comfy Router が配信します。

​

クイックスタート

お使いの Comfy ワークスペースでキーを作成し、COMFY_API_KEY としてエクスポートします。Python、TypeScript、Swift のスニペットは Comfy SDK（pip install comfy-sdk、npm install @comfyorg/sdk、および ComfySwiftSDK Swift パッケージ）を使用しています。cURL のスニペットは、生の HTTP で同じ呼び出しを行うものです。

モデル ID: openai/gpt-image-2.5-sunburst

エンドポイント: POST https://api.comfy.org/v2/models/openai/gpt-image-2.5-sunburst

結果を待つ

Python

from comfy_sdk import Comfy

# 環境変数から COMFY_API_KEY を読み取ります。
# SDK は自動的に冪等性キーを作成し、自動リトライのために再利用します。
with Comfy() as client:
    result = client.models.run(
        "openai/gpt-image-2.5-sunburst",
        {
            "prompt": "a rocketship on a launchpad",
            "quality": "low",
            "size": "1024x1024",
        },
    )

print(result)

キューに送信して後で取得

同じボディを POST https://api.comfy.org/v2/models/openai/gpt-image-2.5-sunburst/requests に送信します。Router は実行が受け付けられるとすぐに 201 と request_id を返し、結果は準備ができ次第、このプロセスからでも別のプロセスからでも取得できます。キュー配信 では、ステータス、キャンセル、取得の流れを順に説明します。

Python

from comfy_sdk import Comfy

# 環境変数から COMFY_API_KEY を読み取ります。
# 各 submit() 呼び出しは独自の Idempotency-Key を生成し、自動リトライのために再利用します。
with Comfy() as client:
    handle = client.models.submit(
        "openai/gpt-image-2.5-sunburst",
        {
            "prompt": "a rocketship on a launchpad",
            "quality": "low",
            "size": "1024x1024",
        },
    )
    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)

​

スキーマ

​

入力

background · string

背景の透明度

指定可能な値: transparent、opaque

image · string | string[]

編集するソース画像。このフィールドの有無が編集操作を選択します。テキストから画像への生成では完全に省略してください。 モデルの公開されている例は、このフィールドを省略した生成呼び出しです。image を追加することが 2 つのモードの違いのすべてです（同じエンドポイント、同じモデル ID）。ただし編集プロンプトはシーンではなく、望む変更を記述するため、以下に示す編集用のボディは、構造上新しいのがこのフィールドだけであっても、生成の例とは異なって見えます。 これは記載どおりにそのままコピーできます: {"prompt": "give the rocketship rainbow coloring", "image": ["data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mP8z8BQDwAEhQGAhKmMIQAAAABJRU5ErkJggg=="], "size": "1024x1024"}。ペイロードは省略形ではなく完全な 1x1 PNG であり、このボディは Router 自身のリクエスト検証テストで受理されるケースとしてピン留めされています。ご自身の画像のバイト列に差し替えてください。 1 枚の画像またはその配列を受け付けます。gpt-image-1 以降は最大 16 枚で、Router はディスパッチ前にこのスキーマに基づいてそれを強制します。

mask · string

1 枚の画像を、Router が呼び出し元に代わって取得する https URL、またはバイト列をインラインで含む data:image/<format>;base64,<payload> URI のいずれかで指定します。受け付ける画像形式は png、webp、jpeg で、このセットはプロバイダーに任されるのではなく解決時に強制されます。svg、gif、avif、tiff はここで拒否され、送信した画像を名指しします。原因から 2 ホップ離れたパートナーエラーになることはありません。 URL 形式を推奨します。base64 ペイロードはおよそ 4/3 に膨張し、リクエストボディ全体の上限は 100 MiB なので、インライン形式ではソース画像が約 75 MB で上限に達します。URL ならこれを完全に回避できます。この説明の最後に記載する画像ごとおよびリクエストごとのメディア上限はボディ上限より厳しいため、ある程度のサイズの画像では先にこちらに達します。 URL は認証情報なしで解決できる必要があります。Router はサーバー側で取得し、呼び出し元の認証情報をリクエストに付けません。そのため、サポートされる形式は署名がクエリ文字列にある署名付き URL です。/api/assets/{id}/content のような認証が必要なエンドポイントは、画像ではなく 401 を Router に返します。その URL はご自身でリクエストし、リダイレクト先の署名付き URL を渡してください。 取得は開かれたインターネットではなく、名前を挙げた一連のホストに限定され、同じリストが送信した URL だけでなくすべてのリダイレクト先にも再適用されます。そのため、それ以外のホストの URL、またはリスト外へリダイレクトする URL は、プロバイダーに接続する前に拒否されます。現在このリストは Comfy 自身のアセット配信のみです。Comfy のアセットバケット配下の署名付き storage.googleapis.com URL で、これは /api/assets/{id}/content がリダイレクトする形式です。パートナー CDN や通常の https ホストはリストに含まれません。 2 つの拡張がロールアウト中で、現時点ではどちらもデフォルトで無効です。これらは 1 つの切り替えの背後で提供され、一緒に有効になります。そのため、以下はすべて今後に提供されるものとして扱い、まだ依存して実装しないでください。どちらかに依存する前に確認してください。 1 つ目は POST /customers/storage がアップロード先として署名するバケットです。ロールアウトがお使いの環境に届くまで、そのエンドポイントからのアップロード URL はここで拒否されます。バケットは Comfy 自身のものでホストも同じであるにもかかわらずです。したがって「Comfy にアップロードしてから URL を渡す」はまだ機能せず、機能するのは /api/assets/{id}/content がリダイレクトする署名付き URL の形式です。 2 つ目は全員に一度にではなくアカウントごとに有効になります。これらのホストの背後にあるバケットは当社のものではなくお客様のものだからです。上記の切り替えがオンになっても、サードパーティの受信メディアが有効化されていないアカウントは拒否され、ホストが未対応であるとは告げられず、その旨の文言で通知されます。Comfy の担当者にアカウントでの有効化を依頼してください。さらに、以下のサードパーティのオブジェクトストレージホストを許可します。ここではバケットはお客様のものであり、Router はその所有権を主張しません: Cloudflare R2（<account>.r2.cloudflarestorage.com、<id>.r2.dev）、Amazon S3（s3.amazonaws.com および s3.<region>.amazonaws.com、パス形式または <bucket>. 接頭辞形式のいずれか）、Azure Blob Storage（<account>.blob.core.windows.net）、Alibaba Cloud OSS（<bucket>.oss-<region>.aliyuncs.com、oss-accelerate エンドポイントを含む）。これらは特にオブジェクトストレージのエンドポイントです。同じプロバイダードメイン上の汎用エンドポイント、たとえば Alibaba Function Compute のトリガーはリストに含まれず、拒否されます。 以下の例は形状のみを示しています。実際の値には署名クエリパラメータも含まれますが、公開された例は仕様に永久に残り、実際の署名は漏えいした認証情報であると同時に機能しなくなるリンクでもあるため、ここでは意図的に省略しています。 各画像は 25 MiB、1 リクエストの画像は合計 64 MiB が上限です。

model · string

実行する gpt-image モデル。Router がアドレス指定されたモデル ID を挿入するため、/v2/models/openai/gpt-image-2 をアドレス指定する呼び出し元はこれを送信しません。

moderation · string

コンテンツモデレーション設定

指定可能な値: low、auto

n · integer

生成する画像の数（1〜10）。

範囲: 1 〜 10

output_compression · integer

JPEG または WebP の圧縮レベル（0〜100）

範囲: 0 〜 100

output_format · string

出力画像の形式

指定可能な値: png、webp、jpeg

prompt · string · 必須

生成する画像、または image に対して行う編集のテキストによる説明。

quality · string

生成または編集された画像の品質

Possible values: low, medium, high, standard, hd

size · string

画像のサイズ（例: 1024x1024、1536x1024、auto）

user · string

エンドユーザー監視用の一意の識別子

GET /v2/models/openai/gpt-image-2.5-sunburst/openapi.json で Router が提供するスキーマから生成されており、これはリクエストがプロバイダーに到達する前に Router が呼び出しを検証する対象となるドキュメントと同じものです。

​

出力

data · object[]

data[].b64_json · string

Base64 でエンコードされた画像データ

data[].revised_prompt · string

改訂されたプロンプト

data[].url · string

画像の URL

usage · object

usage.input_tokens · integer

usage.input_tokens_details · object

usage.input_tokens_details.image_tokens · integer

usage.input_tokens_details.text_tokens · integer

usage.output_tokens · integer

usage.output_tokens_details · object

usage.output_tokens_details.image_tokens · integer

usage.output_tokens_details.text_tokens · integer

usage.total_tokens · integer

background · string

生成された画像の背景が opaque か transparent か。これは OpenAI がこの生成に対して解決した値です。リクエストパラメータの既定値は auto なので、ピン留めしなかった呼び出し元はここでどちらが生成されたのかを知ることになります。

created · integer

生成が完了した時刻の Unix タイムスタンプ（秒）。OpenAI が画像生成レスポンスで REQUIRED として宣言している唯一のメンバーであるため、OpenAI が生成元である限り常に存在します。fal が提供する openai/gpt-image-2 のレスポンスでは、他の 4 つの解決済みパラメータのメンバーと同様に、これは完全に省略されます。int64 として宣言されているのは、現在のエポック値が 2^31 に十分近く、多くの SDK ジェネレーターではフォーマットされていない integer だと 32 ビットのフィールドが生成されてしまうためです。

形式: int64

output_format · string

data[].b64_json 内のバイト列のエンコーディング（png、webp、jpeg のいずれか）。これは OpenAI が実際にエンコードした形式であり、リクエストで指定されていればその output_format、指定されていなければ png になります。そのためデコーダーは、リクエストから形式を再導出するのではなく、これを基準にできます。

quality · string

生成が実際に実行された品質ティア。OpenAI は low、medium、high、xhigh、max のいずれかを報告します。これはリクエストのエコーではなく解決済みのティアであり、リクエスト側の quality の既定値は auto です。

size · string

生成が実際に実行されたピクセル寸法（<width>x<height> 形式）。これは解決済みのサイズです。リクエストの size は既定値が auto で、auto を明示的に許容しているため、実際に使用された寸法が報告されるのはここだけです。

​

例

​

入力

{
  "prompt": "a rocketship on a launchpad",
  "quality": "low",
  "size": "1024x1024"
}

​

出力

{
  "created": 1767225600,
  "data": [
    {
      "b64_json": "PGJhc2U2ND4="
    }
  ],
  "usage": {
    "input_tokens": 12,
    "output_tokens": 1056,
    "total_tokens": 1068
  }
}

​

出荷前の確認

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

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

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

このページは、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 を参照してください。

ヘッダー

認証、冪等性、リクエスト ID、エラー分類、リトライ間隔、支出上限。

Router API の利用

モデルの検出、バリデーションエラー、リトライ、課金。

制限事項

Router が現在対応していないことと、代替手段。