> ## Documentation Index
> Fetch the complete documentation index at: https://dripart-chore-sync-comfy-api-v2-spec.mintlify.site/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)でキーを作成し、`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`

<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-4o",
              {
                  "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-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}"
      ```
    </CodeGroup>
  </Tab>

  <Tab title="Queue and collect later">
    同じボディを `POST https://api.comfy.org/v2/models/openai/gpt-4o/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-4o",
              {
                  "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-4o", {
        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-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. 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-4o/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-4o/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">
  モデルのコンテキストの最初の項目として、システム（または開発者）メッセージを挿入します。
</ParamField>

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

  範囲: `1` から `…`
</ParamField>

<ParamField body="model" type="string">
  OpenAI モデル識別子。Comfy Router ではこのフィールドは任意で、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">
  送信した呼び出し元が拒否されないように宣言されていますが、このサーフェスでは無効です。Router はディスパッチ前にこれを `false` に確定します。これは `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">
  ニュークリアスサンプリングのカットオフ。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 はこれを応答側で設定するので、呼び出し元が送信する理由はありません。
</ParamField>

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

### 出力

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

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

<ResponseField name="max_output_tokens" type="integer">
  レスポンスで生成できるトークン数の上限です。表示される出力トークンと[推論トークン](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。これを使ってマルチターンの会話を作成します。[会話状態](https://platform.openai.com/docs/guides/conversation-state)の詳細をご覧ください。
</ResponseField>

<ResponseField name="reasoning" type="object">
  **o シリーズモデル限定**

  [推論モデル](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 シリーズモデル限定**

  [推論モデル](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 スキーマに一致することが保証されます。詳細は [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">
  レスポンス内で処理できる、組み込みツールへの合計呼び出し回数の最大値。
</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 および 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>

## 例

### 入力

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