Comfy Router で GPT Image 1 を使用する

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

openai/gpt-image-1 の API リファレンス。OpenAI から 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-1

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

結果を待つ

Python

from comfy_sdk import Comfy

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

print(result)

後でキューに入れて収集する

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

Python

from comfy_sdk import Comfy

# 環境変数から COMFY_API_KEY を読み取ります。
# 各 submit() 呼び出しは独自の Idempotency-Key を発行し、自動リトライのために再利用します。
with Comfy() as client:
    handle = client.models.submit(
        "openai/gpt-image-1",
        {
            "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[]

編集対象のソース画像。このフィールドの有無が編集操作を選択します。テキストから画像への生成では完全に省略してください。 モデルの公開されている例は GENERATION 呼び出しで、このフィールドを省略しています。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

生成または編集された画像の品質可能な値: low、medium、high、standard、hd

size · string

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

user · string

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

Router が GET /v2/models/openai/gpt-image-1/openapi.json で提供しているスキーマから生成済みです。これは、リクエストがプロバイダーに到達する前に 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 に十分近いため、フォーマットされていない integer は多くの SDK ジェネレータで 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 が現在対応していないことと、代替手段。