Comfy Router で o1-pro を使う

openai/o1-pro の API リファレンス。OpenAI から Comfy Router 経由で提供されます。

クイックスタート

Comfy ワークスペースでキーを作成し、COMFY_API_KEY としてエクスポートします。Python と TypeScript のスニペットは Comfy SDK（pip install comfy-sdk、npm install @comfyorg/sdk）を使用しています。cURL のスニペットは、生の HTTP で同じ呼び出しを行います。 モデル ID: openai/o1-pro エンドポイント: POST https://api.comfy.org/v2/models/openai/o1-pro

Wait for the result
Queue and collect later

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-pro",
        {
            "input": "Reply with the single word: ok",
            "max_output_tokens": 1024,
        },
    )

print(result)

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-pro", {
  input: "Reply with the single word: ok",
  max_output_tokens: 1024,
});

console.log(data);

curl https://api.comfy.org/v2/models/openai/o1-pro \
  -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}"

同じボディを POST https://api.comfy.org/v2/models/openai/o1-pro/requests に送信します。Router は実行が受け付けられ次第 201 と request_id を返し、結果は準備が整った時点で、このプロセスからでも別のプロセスからでも取得できます。ステータス、キャンセル、結果の取得の詳細は Queued delivery を参照してください。

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-pro",
        {
            "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)

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-pro", {
  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);

# 1. Submit. Router answers 201 with request_id, status_url, response_url and cancel_url.
curl https://api.comfy.org/v2/models/openai/o1-pro/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-pro/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-pro/requests/$REQUEST_ID \
  -H "X-API-Key: $COMFY_API_KEY"

スキーマ

入力

string[]

モデルレスポンスに含める追加の出力データ。

string | object[]

必須

レスポンスを生成するために使用される、モデルへのテキスト、画像、またはファイルの入力。この契約において Router が補えない唯一のフィールドであり、以下の required に含まれる唯一の項目でもあります。

string

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

integer

レスポンスのために生成されるトークン数の上限。可視の出力トークンと推論トークンを含みます。reasoning の ID ではこの上限は非表示の推論トークンと共有されるため、小さな値では可視テキストが現れる前に予算を使い切ってしまいます。そのため reasoning のスモークケースでは 1024 を送信し、chat のケースでは 16 を送信しています。範囲: 1 から …

string

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

boolean

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

string

マルチターン会話のための、前回のレスポンスの ID。

object

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

boolean

OpenAI が生成されたレスポンスを後で取得できるように保存するかどうか。

boolean

送信した呼び出し元が拒否されないように宣言されていますが、このサーフェスでは無効です。Router はディスパッチ前にこれを false に確定します。なぜなら Router は text/event-stream を中継するのではなくプロバイダーのレスポンスを取得するためであり、openAiResponsesProxy の ModifyResponse はそれをデコードできません。そのためストリーミングされた生成は OpenAI によって課金され、誰によっても計量されないことになります。ストリームが必要な場合は POST /proxy/openai/v1/responses を使用してください。

number

サンプリング温度。chat ティア専用。o シリーズの reasoning ID (o1、o1-pro、o3、o4-mini) は OpenAI でこのパラメータを拒否します。Router はそれらのためにこれを拒否しません(2 つのティアが 1 つのスキーマを共有する理由については、このコンポーネントの注記を参照してください)。そのため、これを送信する reasoning 呼び出しには OpenAI 自身のエラーが返されます。範囲: 0 から 2

object

出力フォーマットの設定。例: Structured Outputs のための {"format": {"type": "json_schema", ...}}。変更されずに転送されます。

string | object

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

object[]

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

number

ニュークリアスサンプリングのカットオフ。chat ティア専用で、temperature と同じ条件です。範囲: 0 から 1

string

コンテキストがモデルのウィンドウを超えた場合の切り詰め戦略。上記 3 つの語彙とは異なり、ここでは enum が適用されます。これは、これらの 2 つの値が OpenAI の文書化する完全な集合であり、それが増えていないためです。明示的な null は、上記のフィールドと同じ条件で依然として受け入れられます。指定可能な値: auto、disabled

object

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

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

出力

string

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

integer

レスポンスに対して生成できるトークン数の上限。可視出力トークンと推論トークンを含みます。

string

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

number

デフォルト:"1"

レスポンスのランダム性を制御します範囲: 0 から 2

number

デフォルト:"1"

nucleus サンプリングによりレスポンスの多様性を制御します範囲: 0 から 1

string

デフォルト:"\"disabled\""

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

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

string

モデルへの前のレスポンスの一意の ID。これを使用してマルチターン会話を作成します。詳細は会話状態を参照してください。

object

o シリーズモデル専用推論モデルの設定オプション。

string

以降のターンでモデルに返される推論項目を制御します。例: auto、current_turn、all_turns。

string

デフォルト:"\"medium\""

o シリーズモデル専用推論モデルの推論エフォートを制約します。現在サポートされている値は low、medium、high です。推論エフォートを下げると、レスポンスが速くなり、レスポンス内の推論に使用されるトークンが少なくなる場合があります。使用可能な値: low, medium, high

string

非推奨: 代わりに summary を使用してください。モデルが実行した推論の要約。これはデバッグやモデルの推論プロセスの理解に役立ちます。auto、concise、detailed のいずれかです。使用可能な値: auto, concise, detailed

string

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

string

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

object

モデルが出力する必要がある形式を指定するオブジェクト。{ "type": "json_schema" } を設定すると Structured Outputs が有効になり、指定した JSON schema にモデルが一致するようになります。詳細は Structured Outputs ガイドを参照してください。デフォルトの形式は { "type": "text" } で、追加オプションはありません。gpt-4o 以降のモデルには推奨されません:{ "type": "json_object" } に設定すると、古い JSON モードが有効になり、モデルが生成するメッセージが有効な JSON であることが保証されます。対応しているモデルでは json_schema の使用が推奨されます。

string

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

`none`, `auto`, `required` | object

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

object[]

boolean

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

object

レスポンスの課金情報。

string

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

number

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

number

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

object

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

string

必須

レスポンスのエラーコード。可能な値: 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

string

必須

エラーを人間が読める形式で説明したもの。

number

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

string

この Response の一意の識別子。

object

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

string

レスポンスが不完全である理由。可能な値: max_output_tokens, content_filter

integer

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

object

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

object

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

string

このリソースのオブジェクトタイプ。常に response に設定されます。可能な値: response

object[]

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

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

string

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

boolean

デフォルト:"true"

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

number

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

string

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

string

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

string

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

string

リクエストの処理に使用される処理ティア（例: auto、default、flex、scale、priority）。

string

レスポンス生成のステータス。completed、failed、in_progress、cancelled、queued、incomplete のいずれか。可能な値: completed, failed, in_progress, cancelled, queued, incomplete

boolean

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

object

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

object

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

integer

object

integer

object

integer

object

ウェブ検索ツールの使用量。

integer

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

object

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

integer

必須

入力トークンの数。

object

必須

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

integer

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

integer

必須

キャッシュから取得されたトークン数です。プロンプトキャッシュの詳細。

integer

必須

出力トークン数です。

object

必須

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

integer

必須

推論トークン数です。

integer

必須

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

string

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

使用例

入力

{
  "input": "Reply with the single word: ok",
  "max_output_tokens": 1024
}

出力

{
  "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 の有効期限があるため、早めにダウンロードしてください。

ヘッダー

認証、冪等性、リクエスト ID、エラー分類、リトライ間隔、支出上限。

Router API の利用

モデルの検出、バリデーションエラー、リトライ、課金。

制限事項

Router が現在対応していないことと、代替手段。

Comfy で開発する

ワークフローの実行

Comfy Router

Comfy CLI

仕様

Comfy Router で o1-pro を使う

クイックスタート

スキーマ

入力

出力

使用例

入力

出力

出荷前の確認

ヘッダー

Router API の利用

制限事項

​クイックスタート

​スキーマ

​入力

​出力

​使用例

​入力

​出力

​出荷前の確認

ヘッダー

Router API の利用

制限事項

クイックスタート

スキーマ

入力

出力

使用例

入力

出力

出荷前の確認