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

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

OpenAI が提供する `openai/o1` の API リファレンスです。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/o1`

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

<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/o1",
              {
                  "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/o1", {
        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/o1 \
        -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/o1/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/o1",
              {
                  "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/o1", {
        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/o1/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/o1/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/o1/requests/$REQUEST_ID \
        -H "X-API-Key: $COMFY_API_KEY"
      ```
    </CodeGroup>
  </Tab>
</Tabs>

## Schema

### 入力

<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">
  応答のために生成されるトークン数の上限。可視出力トークンと reasoning トークンを含みます。reasoning id ではこの上限は隠れた reasoning トークンと共有されるため、小さな値では可視テキストが出力される前にバジェット全体を消費してしまいます。そのため、reasoning のスモークケースでは 1024 を送信し、チャットのケースでは 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` に確定します。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">
  ニュークリアスサンプリングのカットオフ。CHAT ティア専用で、`temperature` と同じ条件です。

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

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

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

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

`GET /v2/models/openai/o1/openapi.json` で Router が提供するスキーマから生成されたもので、リクエストがプロバイダーに到達する前に 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 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">
  このレスポンスが完了したときの Unix タイムスタンプ (秒単位)。ステータスが `completed` の場合にのみ存在します。
</ResponseField>

<ResponseField name="created_at" type="number">
  このレスポンスが作成されたときの Unix タイムスタンプ (秒単位)。
</ResponseField>

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

<ResponseField name="error.code" type="string" required>
  レスポンスのエラーコード。Possible values: `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">
  応答が不完全である理由。

  Possible values: `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` に設定されます。

  Possible values: `response`
</ResponseField>

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

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

<ResponseField name="output_text" type="string">
  `output` 配列内のすべての `output_text` 項目からの集約されたテキスト出力を
  含む SDK 専用の便利なプロパティ（存在する場合）。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` のいずれか。

  Possible values: `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">
  Google／検索ツールの使用状況。
</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>