> ## 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 Mini を使用する

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

`openai/gpt-5-mini` の API リファレンス。OpenAI から Comfy Router によって提供されます。

## クイックスタート

[お使いの Comfy ワークスペース](https://platform.comfy.org/profile/api-keys)でキーを作成し、`COMFY_API_KEY` としてエクスポートします。Python と TypeScript のスニペットは Comfy SDK（`pip install comfy-sdk`、`npm install @comfyorg/sdk`）を使用しています。cURL のスニペットは、同じ呼び出しを生の HTTP で実行するものです。

**モデル ID:** `openai/gpt-5-mini`

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

<Tabs>
  <Tab title="Wait for the result">
    <CodeGroup>
      ```python Python theme={null}
      from comfy_sdk import Comfy

      # Reads COMFY_API_KEY from the environment.
      # The SDK automatically creates an idempotency key and reuses it for automatic retries.
      with Comfy() as client:
          result = client.models.run(
              "openai/gpt-5-mini",
              {
                  "input": "Reply with the single word: ok",
                  "max_output_tokens": 1024,
              },
          )

      print(result)
      ```

      ```typescript TypeScript theme={null}
      import { comfy } from "@comfyorg/sdk";

      // Reads COMFY_API_KEY from the environment.
      // The SDK automatically creates an idempotency key and reuses it for automatic retries.
      const { data } = await comfy.models.run("openai/gpt-5-mini", {
        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-mini \
        -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}"
      ```
    </CodeGroup>
  </Tab>

  <Tab title="Queue and collect later">
    同じボディを `POST https://api.comfy.org/v2/models/openai/gpt-5-mini/requests` に送信します。Router は実行が受け付けられ次第 `201` と `request_id` を返し、結果は準備が整った時点で、このプロセスからでも別のプロセスからでも取得できます。ステータス、キャンセル、結果の取得の詳細は [Queued delivery](/ja/development/comfy-router/queue) を参照してください。

    <CodeGroup>
      ```python Python theme={null}
      from comfy_sdk import Comfy

      # Reads COMFY_API_KEY from the environment.
      # Each submit() call mints its own Idempotency-Key and reuses it for automatic retries.
      with Comfy() as client:
          handle = client.models.submit(
              "openai/gpt-5-mini",
              {
                  "input": "Reply with the single word: ok",
                  "max_output_tokens": 1024,
              },
          )
          print("request_id:", handle.request_id)  # with the model ID, all another process needs

          # Poll until the request completes, waiting the Retry-After the server names.
          for update in handle.iter_events():
              print(update.status, update.queue_position)

          # The provider's own payload, the same value models.run() returns.
          # A request that failed or was cancelled raises the typed Router error here.
          result = handle.get()

      print(result)
      ```

      ```typescript TypeScript theme={null}
      import { comfy } from "@comfyorg/sdk";

      // Reads COMFY_API_KEY from the environment.
      // Each submit() call mints its own Idempotency-Key and reuses it for automatic retries.
      const handle = await comfy.models.submit("openai/gpt-5-mini", {
        input: "Reply with the single word: ok",
        max_output_tokens: 1024,
      });
      console.log("requestId:", handle.requestId); // with the model ID, all another process needs

      // Poll until the request completes, waiting the Retry-After the server names.
      for await (const update of handle.events()) {
        console.log(update.status, update.queuePosition);
      }

      // The same result models.run() returns. A request that failed or was cancelled rejects here.
      const result = await handle.get();

      console.log(result.data);
      ```

      ```bash cURL theme={null}
      # 1. Submit. Router answers 201 with request_id, status_url, response_url and cancel_url.
      curl https://api.comfy.org/v2/models/openai/gpt-5-mini/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. Poll until status is COMPLETED, waiting the Retry-After seconds each response names.
      REQUEST_ID="<request_id from the 201 body>"
      curl -i https://api.comfy.org/v2/models/openai/gpt-5-mini/requests/$REQUEST_ID/status \
        -H "X-API-Key: $COMFY_API_KEY"

      # 3. Collect. 200 with the model's native output, 202 with the status body while it is still running.
      curl https://api.comfy.org/v2/models/openai/gpt-5-mini/requests/$REQUEST_ID \
        -H "X-API-Key: $COMFY_API_KEY"
      ```
    </CodeGroup>
  </Tab>
</Tabs>

## スキーマ

### 入力

<ParamField body="include" type="string[]">
  モデル応答に含める追加の出力データ。
</ParamField>

<ParamField body="input" type="string | object[]" required>
  モデルへのテキスト、画像、ファイル入力。応答の生成に使用されます。このコントラクトで Router が補うことのできない唯一のフィールドであり、以下の `required` に含まれる唯一の項目です。
</ParamField>

<ParamField body="instructions" type="string">
  モデルのコンテキストの最初の項目として system (または developer) メッセージを挿入します。
</ParamField>

<ParamField body="max_output_tokens" type="integer">
  1 つの応答で生成されるトークン数の上限。表示される出力トークンと推論トークンを含みます。reasoning id ではこの上限は隠れた推論トークンと共有されるため、値が小さいと可視テキストが一切現れる前に予算をすべて使い切ってしまいます。reasoning のスモークケースが 1024 を送り、chat のケースが 16 を送るのはこのためです。

  範囲: `1` ～ `…`
</ParamField>

<ParamField body="model" type="string">
  OpenAI のモデル識別子。Comfy Router ではこのフィールドは OPTIONAL であり、Router が `{model}` パスセグメントから補います。明示的な `null` も同じように置き換えられます。パスと一致しない値を送信すると拒否されます。
</ParamField>

<ParamField body="parallel_tool_calls" type="boolean">
  モデルがツール呼び出しを並列で実行することを許可するかどうか。
</ParamField>

<ParamField body="previous_response_id" type="string">
  マルチターン会話で使用する、前の応答の ID。
</ParamField>

<ParamField body="reasoning" type="object">
  REASONING 層専用。reasoning モデルの設定。例: `{"effort": "medium"}`。そのまま転送されます。受け付けられるキーについては OpenAI の reasoning ガイドを参照してください。chat 層の id では無視されます。
</ParamField>

<ParamField body="store" type="boolean">
  OpenAI が生成した応答を後で取得できるように保存するかどうか。
</ParamField>

<ParamField body="stream" type="boolean">
  送信した呼び出し元が拒否されないように宣言されていますが、このサーフェスでは INERT です。Router はディスパッチ前にこれを `false` に確定します。Router は `text/event-stream` を中継するのではなくプロバイダーの応答を取り込むためです。openAiResponsesProxy の ModifyResponse はこれをデコードできないため、ストリーミング生成は OpenAI から課金されても誰にも計測されません。ストリームが必要な場合は `POST /proxy/openai/v1/responses` を使用してください。
</ParamField>

<ParamField body="temperature" type="number">
  サンプリング温度。CHAT 層専用: o シリーズの reasoning id (`o1`、`o1-pro`、`o3`、`o4-mini`) は OpenAI 側でこのパラメータを拒否します。Router はそれらに対してこれを拒否しません (2 つの層が 1 つのスキーマを共有する理由については、このコンポーネントの注記を参照してください)。そのため、これを送信する reasoning 呼び出しには OpenAI 自身のエラーが返されます。

  範囲: `0` ～ `2`
</ParamField>

<ParamField body="text" type="object">
  出力フォーマットの設定。例: Structured Outputs 用の `{"format": {"type": "json_schema", ...}}`。そのまま転送されます。
</ParamField>

<ParamField body="tool_choice" type="string | object">
  モデルが使用するツールをどのように選択すべきか。文字列のモードか、ツールを指定するオブジェクトのいずれかです。
</ParamField>

<ParamField body="tools" type="object[]">
  モデルが呼び出せるツール定義。Router はツールの分類を狭めません。受け付けられる形については OpenAI の Responses API リファレンスを参照してください。
</ParamField>

<ParamField body="top_p" type="number">
  Nucleus サンプリングのカットオフ。CHAT 層専用で、`temperature` と同じ条件です。

  範囲: `0` ～ `1`
</ParamField>

<ParamField body="truncation" type="string">
  コンテキストがモデルのウィンドウを超えたときの切り詰め戦略。上記の 3 つの語彙とは異なり、ここでは enum が適用されます。この 2 つの値が OpenAI のドキュメントに記載された完全な集合であり、増えていないためです。明示的な `null` は、上記のフィールドと同じ条件で引き続き受け付けられます。

  指定可能な値: `auto`、`disabled`
</ParamField>

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

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

### 出力

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

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

<ResponseField name="max_output_tokens" type="integer">
  レスポンスで生成できるトークン数の上限です。可視の出力トークンと[reasoning tokens](https://platform.openai.com/docs/guides/reasoning)が含まれます。
</ResponseField>

<ResponseField name="model" type="string">
  レスポンスの生成に使用されるモデル
</ResponseField>

<ResponseField name="temperature" type="number" default="1">
  レスポンスのランダム性を制御します

  範囲: `0` から `2`
</ResponseField>

<ResponseField name="top_p" type="number" default="1">
  ニュークリアスサンプリングによるレスポンスの多様性を制御します

  範囲: `0` から `1`
</ResponseField>

<ResponseField name="truncation" type="string" default="&#x22;disabled&#x22;">
  モデルレスポンスに使用するトランケーション戦略。

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

    指定可能な値: `auto`、`disabled`
</ResponseField>

<ResponseField name="previous_response_id" type="string">
  モデルに対する前のレスポンスの一意の ID。これを使用して
  マルチターンの会話を作成します。詳細は
  [conversation state](https://platform.openai.com/docs/guides/conversation-state)をご覧ください。
</ResponseField>

<ResponseField name="reasoning" type="object">
  **o-series モデル専用**

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

<ResponseField name="reasoning.context" type="string">
  以降のターンでモデルに返される推論項目を制御します。例: `auto`、`current_turn`、`all_turns`。
</ResponseField>

<ResponseField name="reasoning.effort" type="string" default="&#x22;medium&#x22;">
  **o-series モデル専用**

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

  指定可能な値: `low`、`medium`、`high`
</ResponseField>

<ResponseField name="reasoning.generate_summary" type="string">
  **非推奨:** 代わりに `summary` を使用してください。

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

  指定可能な値: `auto`、`concise`、`detailed`
</ResponseField>

<ResponseField name="reasoning.mode" type="string">
  レスポンスに使用される推論モード。
</ResponseField>

<ResponseField name="reasoning.summary" type="string">
  モデルが実行した推論の要約。デバッグやモデルの推論プロセスの
  理解に役立ちます。
  `auto`、`concise`、`detailed` のいずれかです。

  指定可能な値: `auto`、`concise`、`detailed`
</ResponseField>

<ResponseField name="text" type="object" />

<ResponseField name="text.format" type="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` の使用が推奨されます。
</ResponseField>

<ResponseField name="text.verbosity" type="string">
  モデルのレスポンスの冗長さを制約します。`low`、`medium`、`high` のいずれかです。
</ResponseField>

<ResponseField name="tool_choice" type="`none`, `auto`, `required` | object">
  レスポンスを生成する際に、モデルがどのツール（または複数のツール）を
  使用するかを選択する方法。モデルが呼び出せるツールを指定する方法については、
  `tools` パラメータを参照してください。
</ResponseField>

<ResponseField name="tools" type="object[]" />

<ResponseField name="background" type="boolean">
  モデルレスポンスがバックグラウンドで実行されるかどうか。
</ResponseField>

<ResponseField name="billing" type="object">
  レスポンスの課金情報。
</ResponseField>

<ResponseField name="billing.payer" type="string">
  レスポンスの支払いを担当する当事者。
</ResponseField>

<ResponseField name="completed_at" type="number">
  この Response が完了したときの Unix タイムスタンプ（秒）。ステータスが `completed` の場合にのみ存在します。
</ResponseField>

<ResponseField name="created_at" type="number">
  この Response が作成されたときの Unix タイムスタンプ（秒）。
</ResponseField>

<ResponseField name="error" type="object">
  モデルが Response の生成に失敗したときに返されるエラーオブジェクト。
</ResponseField>

<ResponseField name="error.code" type="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`
</ResponseField>

<ResponseField name="error.message" type="string" required>
  エラーの内容を人間が読める形式で説明したもの。
</ResponseField>

<ResponseField name="frequency_penalty" type="number">
  これまでのテキスト内での出現頻度に基づいて新しいトークンにペナルティを与える。
</ResponseField>

<ResponseField name="id" type="string">
  この Response の一意な識別子。
</ResponseField>

<ResponseField name="incomplete_details" type="object">
  レスポンスが不完全である理由に関する詳細。
</ResponseField>

<ResponseField name="incomplete_details.reason" type="string">
  レスポンスが不完全である理由。

  指定可能な値: `max_output_tokens`、`content_filter`
</ResponseField>

<ResponseField name="max_tool_calls" type="integer">
  1 つのレスポンスで処理できる、組み込みツールへの総呼び出し回数の上限。
</ResponseField>

<ResponseField name="metadata" type="object">
  レスポンスに付加できるキーと値のペアのセット。
</ResponseField>

<ResponseField name="moderation" type="object">
  モデレーションされた完了が要求された場合の、レスポンスの入力と出力に対するモデレーション結果。
</ResponseField>

<ResponseField name="object" type="string">
  このリソースのオブジェクト種別。常に `response` に設定される。

  指定可能な値: `response`
</ResponseField>

<ResponseField name="output" type="object[]">
  モデルによって生成されたコンテンツ項目の配列。

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

<ResponseField name="output_text" type="string">
  SDK 専用の便利なプロパティで、`output` 配列内のすべての `output_text` 項目
  （存在する場合）のテキスト出力を集約したもの。Python SDK と JavaScript SDK でサポートされている。
</ResponseField>

<ResponseField name="parallel_tool_calls" type="boolean" default="true">
  モデルがツール呼び出しを並列で実行することを許可するかどうか。
</ResponseField>

<ResponseField name="presence_penalty" type="number">
  これまでのテキスト内に出現するかどうかに基づいて新しいトークンにペナルティを与える。
</ResponseField>

<ResponseField name="prompt_cache_key" type="string">
  類似したリクエストのレスポンスをキャッシュしてキャッシュヒット率を最適化するために OpenAI が使用する。`user` フィールドを置き換える。
</ResponseField>

<ResponseField name="prompt_cache_retention" type="string">
  プロンプトキャッシュの保持ポリシー。例: `in_memory` または `24h`。
</ResponseField>

<ResponseField name="safety_identifier" type="string">
  OpenAI の利用ポリシーに違反している可能性のある、アプリケーションのユーザーを検出するために使用される安定した識別子。
</ResponseField>

<ResponseField name="service_tier" type="string">
  リクエストの処理に使用される処理ティア。例: `auto`、`default`、`flex`、`scale`、`priority`。
</ResponseField>

<ResponseField name="status" type="string">
  レスポンス生成のステータス。`completed`、`failed`、`in_progress`、`cancelled`、`queued`、`incomplete` のいずれか。

  指定可能な値: `completed`、`failed`、`in_progress`、`cancelled`、`queued`、`incomplete`
</ResponseField>

<ResponseField name="store" type="boolean">
  レスポンスが後で API 経由で取得できるように保存されるかどうか。
</ResponseField>

<ResponseField name="tool_usage" type="object">
  組み込みツールごとに分類したトークンとリクエストの使用量。
</ResponseField>

<ResponseField name="tool_usage.image_gen" type="object">
  画像生成ツールのトークン使用量。
</ResponseField>

<ResponseField name="tool_usage.image_gen.input_tokens" type="integer" />

<ResponseField name="tool_usage.image_gen.input_tokens_details" type="object" />

<ResponseField name="tool_usage.image_gen.input_tokens_details.image_tokens" type="integer" />

<ResponseField name="tool_usage.image_gen.input_tokens_details.text_tokens" type="integer" />

<ResponseField name="tool_usage.image_gen.output_tokens" type="integer" />

<ResponseField name="tool_usage.image_gen.output_tokens_details" type="object" />

<ResponseField name="tool_usage.image_gen.output_tokens_details.image_tokens" type="integer" />

<ResponseField name="tool_usage.image_gen.output_tokens_details.text_tokens" type="integer" />

<ResponseField name="tool_usage.image_gen.total_tokens" type="integer" />

<ResponseField name="tool_usage.web_search" type="object">
  Web 検索ツールの使用量。
</ResponseField>

<ResponseField name="tool_usage.web_search.num_requests" type="integer" />

<ResponseField name="top_logprobs" type="integer">
  各トークン位置で返す、最も可能性の高いトークンの最大数。それぞれにログ確率が付随する。
</ResponseField>

<ResponseField name="usage" type="object">
  入力トークン、出力トークン、出力トークンの内訳、
  使用された合計トークンを含むトークン使用量の詳細を表す。
</ResponseField>

<ResponseField name="usage.input_tokens" type="integer" required>
  入力トークンの数。
</ResponseField>

<ResponseField name="usage.input_tokens_details" type="object" required>
  入力トークンの詳細な内訳。
</ResponseField>

<ResponseField name="usage.input_tokens_details.cache_write_tokens" type="integer">
  キャッシュに書き込まれた入力トークンの数。
</ResponseField>

<ResponseField name="usage.input_tokens_details.cached_tokens" type="integer" required>
  キャッシュから取得されたトークン数です。
  [プロンプトキャッシュの詳細](https://platform.openai.com/docs/guides/prompt-caching)。
</ResponseField>

<ResponseField name="usage.output_tokens" type="integer" required>
  出力トークン数です。
</ResponseField>

<ResponseField name="usage.output_tokens_details" type="object" required>
  出力トークンの詳細な内訳です。
</ResponseField>

<ResponseField name="usage.output_tokens_details.reasoning_tokens" type="integer" required>
  推論トークン数です。
</ResponseField>

<ResponseField name="usage.total_tokens" type="integer" required>
  使用されたトークンの合計数です。
</ResponseField>

<ResponseField name="user" type="string">
  エンドユーザー向けの非推奨の識別子です。`safety_identifier` と `prompt_cache_key` に置き換えられました。
</ResponseField>

<h2 id="examples">
  Examples
</h2>

### 入力

```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 が入力を拒否したことを意味します。生成されたアセットは [結果 URL の有効期限](/ja/development/comfy-router/reference#結果アセット) があるため、早めにダウンロードしてください。

<CardGroup cols={3}>
  <Card title="ヘッダー" icon="list" href="/ja/development/comfy-router/quickstart">
    認証、冪等性、リクエスト ID、エラー分類、リトライ間隔、支出上限。
  </Card>

  <Card title="Router API の利用" icon="code" href="/ja/development/comfy-router/quickstart">
    モデルの検出、バリデーションエラー、リトライ、課金。
  </Card>

  <Card title="制限事項" icon="triangle-exclamation" href="/ja/development/comfy-router/limitations">
    Router が現在対応していないことと、代替手段。
  </Card>
</CardGroup>
