> ## 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 で GPT 4o を使用する

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

`openai/gpt-4o` の API リファレンスです。OpenAI のモデルを 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 のスニペットは、生の HTTP で同じ呼び出しを行います。

**モデル ID:** `openai/gpt-4o`

**エンドポイント:** `POST https://api.comfy.org/v2/models/openai/gpt-4o`

> [tab] 結果を待つ
>
> ```python Python theme={null}
> from comfy_sdk import Comfy
>
> # 環境から COMFY_API_KEY を読み取ります。
> # SDK は自動的に冪等キーを作成し、自動リトライのために再利用します。
> with Comfy() as client:
>     result = client.models.run(
>         "openai/gpt-4o",
>         {
>             "input": "Reply with the single word: ok",
>             "max_output_tokens": 1024,
>         },
>     )
>
> print(result)
> ```
>
> ```typescript TypeScript theme={null}
> import { comfy } from "@comfyorg/sdk";
>
> // 環境から COMFY_API_KEY を読み取ります。
> // SDK は自動的に冪等キーを作成し、自動リトライのために再利用します。
> const { data } = await comfy.models.run("openai/gpt-4o", {
>   input: "Reply with the single word: ok",
>   max_output_tokens: 1024,
> });
>
> console.log(data);
> ```
>
> ```bash cURL theme={null}
> curl https://api.comfy.org/v2/models/openai/gpt-4o \
>   -H "X-API-Key: $COMFY_API_KEY" \
>   -H "Idempotency-Key: $(uuidgen)" \
>   -H "Content-Type: application/json" \
>   -d "{\"input\": \"Reply with the single word: ok\", \"max_output_tokens\": 1024}"
> ```

> [tab] キューに送信して後で収集
>
> 同じボディを `POST https://api.comfy.org/v2/models/openai/gpt-4o/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(
>             "openai/gpt-4o",
>             {
>                 "input": "Reply with the single word: ok",
>                 "max_output_tokens": 1024,
>             },
>         )
>         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("openai/gpt-4o", {
>   input: "Reply with the single word: ok",
>   max_output_tokens: 1024,
> });
> 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/openai/gpt-4o/requests \
>   -H "X-API-Key: $COMFY_API_KEY" \
>   -H "Idempotency-Key: $(uuidgen)" \
>   -H "Content-Type: application/json" \
>   -d "{\"input\": \"Reply with the single word: ok\", \"max_output_tokens\": 1024}"
>
> # 2. ステータスが COMPLETED になるまでポーリングし、各レスポンスが指定する Retry-After 秒だけ待機します。
> REQUEST_ID="<request_id from the 201 body>"
> curl -i https://api.comfy.org/v2/models/openai/gpt-4o/requests/$REQUEST_ID/status \
>   -H "X-API-Key: $COMFY_API_KEY"
>
> # 3. 収集。200 はモデルのネイティブ出力、実行中はステータスボディとともに 202 を返します。
> curl https://api.comfy.org/v2/models/openai/gpt-4o/requests/$REQUEST_ID \
>   -H "X-API-Key: $COMFY_API_KEY"
> ```

## スキーマ

### 入力

**include** `string[]`

モデル応答に含める追加の出力データ。

**input** `string | object[]` *required*

モデルへのテキスト、画像、ファイル入力であり、応答の生成に使用される。この契約で Router が提供できない唯一のフィールドで、以下の `required` にある唯一のエントリでもある。

**instructions** `string`

モデルのコンテキストの最初の項目として、システム（または developer）メッセージを挿入する。

**max\_output\_tokens** `integer`

応答のために生成されるトークン数の上限。可視出力トークンと reasoning トークンを含む。reasoning id では、この上限は非表示の reasoning トークンと共有されるため、小さな値だと可視テキストが現れる前に予算全体を消費してしまう。これが、reasoning のスモークケースでは 1024 を送信し、chat のケースでは 16 を送信する理由である。

範囲：`1` ～ `…`

**model** `string`

OpenAI モデル識別子。Comfy Router ではこのフィールドは任意であり、Router は `{model}` パスセグメントからこれを埋める。明示的な `null` も同じ方法で置き換えられる。パスと一致しない値を送信すると拒否される。

**parallel\_tool\_calls** `boolean`

モデルがツール呼び出しを並列実行することを許可するかどうか。

**previous\_response\_id** `string`

マルチターン会話で使用する、前の応答の ID。

**reasoning** `object`

REASONING ティア専用。reasoning モデルの設定。例：`{"effort": "medium"}`。変更なしで転送される。受け入れられるキーについては OpenAI の reasoning ガイドを参照。chat ティアの id はこれを無視する。

**store** `boolean`

OpenAI が生成済みの応答を後で取得できるように保存するかどうか。

**stream** `boolean`

送信する呼び出し元が拒否されないように宣言されているが、このサーフェスでは無効である。Router はディスパッチ前にこれを `false` に確定する。これは、`text/event-stream` を中継するのではなくプロバイダー応答をキャプチャするためであり、それをデコードできないので、ストリーミング生成は OpenAI によって課金されるが、誰にもメータリングされない。Comfy のどのサーフェスもストリームを提供しない。v1 の `POST /proxy/openai/v1/responses` イングレスは `stream: true` を 400 で拒否し、そのリクエストをアップストリームへ決して転送しない。したがって、どちらのサーフェスでもこのフィールドを省略するか `false` を送信し、完了した応答を 1 つの JSON ボディとして読むこと。

**temperature** `number`

サンプリング温度。CHAT ティア専用：o シリーズの reasoning id（`o1`、`o1-pro`、`o3`、`o4-mini`）は OpenAI でこのパラメータを拒否する。Router はそれらに対してこれを拒否しない。2 つのティアが 1 つのスキーマを共有する理由については、このコンポーネントの注記を参照。したがって、これを送信する reasoning 呼び出しには OpenAI 自身のエラーが返る。

範囲：`0` ～ `2`

**text** `object`

出力フォーマット設定。例：Structured Outputs 用の `{"format": {"type": "json_schema", ...}}`。変更なしで転送される。

**tool\_choice** `string | object`

モデルが使用するツールをどのように選択すべきか。文字列モード、またはツールを指定するオブジェクトのいずれか。

**tools** `object[]`

モデルが呼び出せるツール定義。Router はツール分類を狭めない。受け入れられる形については OpenAI の Responses API リファレンスを参照。

**top\_p** `number`

Nucleus サンプリングのカットオフ。CHAT ティア専用で、`temperature` と同じ条件。

範囲：`0` ～ `1`

**truncation** `string`

コンテキストがモデルのウィンドウを超える場合の切り捨て戦略。ここでは enum が強制される。上記の 3 つの語彙とは異なり、これらの 2 つの値は OpenAI が文書化している完全な集合であり、増えていないためである。明示的な `null` も、その上のフィールドと同じ条件で引き続き受け入れられる。

可能な値：`auto`、`disabled`

**usage** `object`

トークン使用量のエンベロープ。この契約に存在するのは、v1 オペレーションがリクエストボディでこれを宣言しているためである。OpenAI はこれを RESPONSE で設定するので、呼び出し元が送信する理由はない。

Router が `GET /v2/models/openai/gpt-4o/openapi.json` で提供するスキーマから生成されたもので、リクエストがプロバイダーに到達する前に呼び出しを検証するのと同じドキュメントである。

### 出力

**instructions** `string`

モデルのコンテキストの最初の項目として、システム（または開発者）メッセージを挿入します。

`previous_response_id` と併用する場合、前のレスポンスの instructions は次のレスポンスに引き継がれません。これにより、新しいレスポンスでシステム（または開発者）メッセージを簡単に差し替えられます。

**max\_output\_tokens** `integer`

レスポンスで生成できるトークン数の上限。可視出力トークンと[推論トークン](https://platform.openai.com/docs/guides/reasoning)を含みます。

**model** `string`

レスポンスの生成に使用するモデル

**temperature** `number` (default: 1)

レスポンスのランダム性を制御します

範囲: `0` から `2`

**top\_p** `number` (default: 1)

nucleus sampling によりレスポンスの多様性を制御します

範囲: `0` から `1`

**truncation** `string` (default: "disabled")

モデルレスポンスに使用する切り捨て戦略。

* `auto`: このレスポンスと以前のレスポンスのコンテキストがモデルのコンテキストウィンドウサイズを超える場合、モデルは会話の途中の入力項目を削除してコンテキストウィンドウに収まるようにレスポンスを切り捨てます。
* `disabled`（デフォルト）: モデルレスポンスがモデルのコンテキストウィンドウサイズを超える場合、リクエストは 400 エラーで失敗します。

  指定可能な値: `auto`, `disabled`

**previous\_response\_id** `string`

モデルへの前のレスポンスの一意の ID。これを使用して
マルチターンの会話を作成します。[会話の状態](https://platform.openai.com/docs/guides/conversation-state)について詳しく学べます。

**reasoning** `object`

**o-series モデルのみ**

[推論モデル](https://platform.openai.com/docs/guides/reasoning)の
設定オプション。

**reasoning.context** `string`

後のターンでどの推論項目をモデルに返すかを制御します（例: `auto`、`current_turn`、`all_turns`）。

**reasoning.effort** `string` (default: "medium")

**o-series モデルのみ**

[推論モデル](https://platform.openai.com/docs/guides/reasoning)の
推論にかける努力を制約します。
現在サポートされている値は `low`、`medium`、`high` です。推論の
努力を減らすと、レスポンスが速くなり、レスポンスで推論に使用される
トークンが少なくなる場合があります。

指定可能な値: `low`, `medium`, `high`

**reasoning.generate\_summary** `string`

**非推奨:** 代わりに `summary` を使用してください。

モデルが実行した推論の要約。これは
デバッグやモデルの推論プロセスの理解に役立ちます。
`auto`、`concise`、`detailed` のいずれかです。

指定可能な値: `auto`, `concise`, `detailed`

**reasoning.mode** `string`

レスポンスに使用される推論モード。

**reasoning.summary** `string`

モデルが実行した推論の要約。これは
デバッグやモデルの推論プロセスの理解に役立ちます。
`auto`、`concise`、`detailed` のいずれかです。

指定可能な値: `auto`, `concise`, `detailed`

**text** `object`

**text.format** `object`

モデルが出力する必要がある形式を指定するオブジェクト。

`{ "type": "json_schema" }` を設定すると Structured Outputs が有効になり、
モデルが指定した JSON schema に一致することが保証されます。詳細は
[Structured Outputs ガイド](https://platform.openai.com/docs/guides/structured-outputs)を参照してください。

デフォルトの形式は `{ "type": "text" }` で、追加のオプションはありません。

**gpt-4o およびそれ以降のモデルには推奨されません:**

`{ "type": "json_object" }` に設定すると古い JSON モードが有効になり、
モデルが生成するメッセージが有効な JSON であることが保証されます。これを
サポートするモデルでは `json_schema` の使用が推奨されます。

**text.verbosity** `string`

モデルのレスポンスの冗長性を制約します。`low`、`medium`、`high` のいずれかです。

**tool\_choice** \`\`none`, `auto`, `required` | object`

レスポンスを生成する際に、モデルがどのツール（または複数のツール）を
使用するかをどのように選択するか。モデルが呼び出せるツールを指定する方法については、
`tools` パラメータを参照してください。

**tools** `object[]`

**background** `boolean`

モデルレスポンスがバックグラウンドで実行されるかどうか。

**billing** `object`

レスポンスの課金情報。

**billing.payer** `string`

レスポンスの支払いを担当する当事者。

**completed\_at** `number`

この Response が完了したときの Unix タイムスタンプ（秒）。ステータスが `completed` の場合にのみ存在します。

**created\_at** `number`

この Response が作成されたときの Unix タイムスタンプ（秒）。

**error** `object`

モデルが Response の生成に失敗したときに返されるエラーオブジェクト。

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

レスポンスのエラーコード。可能な値: `server_error`, `rate_limit_exceeded`, `invalid_prompt`, `vector_store_timeout`, `invalid_image`, `invalid_image_format`, `invalid_base64_image`, `invalid_image_url`, `image_too_large`, `image_too_small`, `image_parse_error`, `image_content_policy_violation`, `invalid_image_mode`, `image_file_too_large`, `unsupported_image_media_type`, `empty_image_file`, `failed_to_download_image`, `image_file_not_found`

**error.message** `string` *required*

エラーの人間が読める形式の説明。

**frequency\_penalty** `number`

これまでのテキスト内での既存の出現頻度に基づいて新しいトークンにペナルティを与えます。

**id** `string`

この Response の一意の識別子。

**incomplete\_details** `object`

レスポンスが不完全である理由に関する詳細。

**incomplete\_details.reason** `string`

レスポンスが不完全である理由。

可能な値: `max_output_tokens`, `content_filter`

**max\_tool\_calls** `integer`

1 つのレスポンスで処理できる組み込みツールへの総呼び出し回数の上限。

**metadata** `object`

レスポンスに付加できるキーと値のペアのセット。

**moderation** `object`

モデレーション済みの補完が要求された場合の、レスポンスの入力と出力に対するモデレーション結果。

**object** `string`

このリソースのオブジェクト型。常に `response` に設定されます。

可能な値: `response`

**output** `object[]`

モデルによって生成されたコンテンツ項目の配列。

* `output` 配列内の項目の長さと順序は、モデルの応答によって異なります。
* `output` 配列の最初の項目にアクセスして、それがモデルによって生成されたコンテンツを含む `assistant` メッセージであると仮定するのではなく、SDK でサポートされている場合は `output_text` プロパティの使用を検討してください。

**output\_text** `string`

`output` 配列内のすべての `output_text` 項目からの集約されたテキスト出力を含む、SDK 専用の便利なプロパティ（存在する場合）。
Python SDK と JavaScript SDK でサポートされています。

**parallel\_tool\_calls** `boolean` (default: true)

モデルがツール呼び出しを並列で実行することを許可するかどうか。

**presence\_penalty** `number`

これまでのテキスト内に出現するかどうかに基づいて新しいトークンにペナルティを与えます。

**prompt\_cache\_key** `string`

キャッシュヒット率を最適化するために、類似したリクエストに対するレスポンスをキャッシュするために OpenAI によって使用されます。`user` フィールドを置き換えます。

**prompt\_cache\_retention** `string`

プロンプトキャッシュの保持ポリシー。例: `in_memory` または `24h`。

**safety\_identifier** `string`

OpenAI の利用ポリシーに違反する可能性のあるアプリケーションのユーザーを検出するために使用される安定した識別子。

**service\_tier** `string`

リクエストを処理するために使用される処理ティア。例: `auto`、`default`、`flex`、`scale`、または `priority`。

**status** `string`

レスポンス生成のステータス。`completed`、`failed`、`in_progress`、`cancelled`、`queued`、または `incomplete` のいずれか。

可能な値: `completed`, `failed`, `in_progress`, `cancelled`, `queued`, `incomplete`

**store** `boolean`

API を介して後で取得できるようにレスポンスを保存するかどうか。

**tool\_usage** `object`

組み込みツールごとに分類されたトークンとリクエストの使用量。

**tool\_usage.image\_gen** `object`

画像生成ツールのトークン使用量。

**tool\_usage.image\_gen.input\_tokens** `integer`

**tool\_usage.image\_gen.input\_tokens\_details** `object`

**tool\_usage.image\_gen.input\_tokens\_details.image\_tokens** `integer`

**tool\_usage.image\_gen.input\_tokens\_details.text\_tokens** `integer`

**tool\_usage.image\_gen.output\_tokens** `integer`

**tool\_usage.image\_gen.output\_tokens\_details** `object`

**tool\_usage.image\_gen.output\_tokens\_details.image\_tokens** `integer`

**tool\_usage.image\_gen.output\_tokens\_details.text\_tokens** `integer`

**tool\_usage.image\_gen.total\_tokens** `integer`

**tool\_usage.web\_search** `object`

検索ツールの使用量。

**tool\_usage.web\_search.num\_requests** `integer`

**top\_logprobs** `integer`

各トークン位置で返す最も可能性の高いトークンの最大数。それぞれに関連する対数確率が付きます。

**usage** `object`

入力トークン、出力トークン、出力トークンの内訳、および使用された合計トークンを含むトークン使用量の詳細を表します。

**usage.input\_tokens** `integer` *required*

入力トークンの数。

**usage.input\_tokens\_details** `object` *required*

入力トークンの詳細な内訳。

**usage.input\_tokens\_details.cache\_write\_tokens** `integer`

キャッシュに書き込まれた入力トークンの数。

**usage.input\_tokens\_details.cache\_write\_tokens\_details** `object`

キャッシュの有効期間ごとに分割したキャッシュ書き込み。2 つの合計は `cache_write_tokens` になります。

**usage.input\_tokens\_details.cache\_write\_tokens\_details.ttl\_12h\_tokens** `integer`

12 時間の有効期間でキャッシュに書き込まれた入力トークン数。

**usage.input\_tokens\_details.cache\_write\_tokens\_details.ttl\_30m\_tokens** `integer`

30 分の有効期間でキャッシュに書き込まれた入力トークン数。

**usage.input\_tokens\_details.cached\_tokens** `integer` *required*

キャッシュから取得されたトークン数です。
[プロンプトキャッシュの詳細](https://platform.openai.com/docs/guides/prompt-caching)。

**usage.output\_tokens** `integer` *required*

出力トークン数です。

**usage.output\_tokens\_details** `object` *required*

出力トークンの詳細な内訳です。

**usage.output\_tokens\_details.reasoning\_tokens** `integer` *required*

推論トークン数です。

**usage.total\_tokens** `integer` *required*

使用されたトークンの合計数です。

**user** `string`

エンドユーザー用の非推奨の識別子です。`safety_identifier` と `prompt_cache_key` に置き換えられました。

## 例

### 入力

```json theme={null}
{
  "input": "Reply with the single word: ok",
  "max_output_tokens": 1024
}
```

### 出力

```json theme={null}
{
  "completed_at": 1767225601,
  "created_at": 1767225600,
  "id": "resp_0a1b2c3d4e5f6a7b8c9d0e1f",
  "object": "response",
  "output": [
    {
      "content": [
        {
          "annotations": [],
          "text": "ok",
          "type": "output_text"
        }
      ],
      "id": "msg_0a1b2c3d4e5f6a7b8c9d0e1f",
      "role": "assistant",
      "status": "completed",
      "type": "message"
    }
  ],
  "output_text": "ok",
  "status": "completed",
  "usage": {
    "input_tokens": 14,
    "input_tokens_details": {
      "cached_tokens": 0
    },
    "output_tokens": 2,
    "output_tokens_details": {
      "reasoning_tokens": 0
    },
    "total_tokens": 16
  }
}
```

## 出荷前の確認

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.