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

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

`openai/gpt-5` の API リファレンスです。Comfy Router が OpenAI から提供しています。

**入力：** テキスト, 画像 · **出力：** テキスト

## クイックスタート

[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-5`

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

> [tab] 結果を待つ
>
> ```python Python theme={null}
> from comfy_sdk import Comfy
>
> # 環境変数から COMFY_API_KEY を読み取ります。
> # SDK は自動的に冪等キーを作成し、自動リトライのために再利用します。
> with Comfy() as client:
>     result = client.models.run(
>         "openai/gpt-5",
>         {
>             "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-5", {
>   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-5 \
>   -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-5/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-5",
>             {
>                 "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-5", {
>   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-5/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. status が COMPLETED になるまでポーリングし、各レスポンスが指定する Retry-After 秒だけ待機します。
> REQUEST_ID="<request_id from the 201 body>"
> curl -i https://api.comfy.org/v2/models/openai/gpt-5/requests/$REQUEST_ID/status \
>   -H "X-API-Key: $COMFY_API_KEY"
>
> # 3. 取得。実行中はステータスボディとともに 202、完了時はモデルのネイティブな出力とともに 200 が返ります。
> curl https://api.comfy.org/v2/models/openai/gpt-5/requests/$REQUEST_ID \
>   -H "X-API-Key: $COMFY_API_KEY"
> ```

## スキーマ

### 入力

**include** `string[]`

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

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

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

**instructions** `string`

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

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

応答のために生成されるトークン数の上限。可視出力トークンと reasoning トークンを含みます。reasoning 系 ID では、この上限は隠された reasoning トークンと共有されるため、小さな値だと可視テキストが出る前に予算全体を消費してしまいます。そのため、reasoning のスモークケースでは 1024 を送信し、チャットのケースでは 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 ガイドを参照してください。チャットティアの 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`

サンプリング温度。チャットティア専用です。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`

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

範囲: `0` から `1`

**truncation** `string`

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

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

**usage** `object`

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

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

### 出力

**instructions** `string`

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

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

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

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

**model** `string`

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

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

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

範囲: `0` から `2`

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

ニュークリアスサンプリングによるレスポンスの多様性を制御します

範囲: `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 モデル専用**

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

**reasoning.context** `string`

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

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

**o-series モデル専用**

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

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

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

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

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

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

**reasoning.mode** `string`

レスポンスに使用する reasoning モード。

**reasoning.summary** `string`

モデルが実行した reasoning の要約。デバッグやモデルの reasoning プロセスの理解に役立ちます。`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`

SDK 専用の便利なプロパティで、`output` 配列内のすべての `output_text` 項目から集約されたテキスト出力が含まれます（存在する場合）。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`

Web 検索ツールの使用量。

**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.