搭配 Comfy Router 使用 o4-mini

通过 Comfy Router 调用 openai/o4-mini：端点、请求结构以及 Router 返回的响应。

openai/o4-mini 的 API 参考，由 Comfy Router 从 OpenAI 提供。

​

快速开始

在你的 Comfy 工作区中创建一个密钥，并将其导出为 COMFY_API_KEY。Python 和 TypeScript 代码片段使用 Comfy SDK（pip install comfy-sdk 和 npm install @comfyorg/sdk）；cURL 代码片段是通过原始 HTTP 发起的同一调用。

模型 ID： openai/o4-mini

端点： POST https://api.comfy.org/v2/models/openai/o4-mini

等待结果

Python

from comfy_sdk import Comfy

# 从环境变量读取 COMFY_API_KEY。
# SDK 会自动创建幂等键，并在自动重试时复用它。
with Comfy() as client:
    result = client.models.run(
        "openai/o4-mini",
        {
            "input": "Reply with the single word: ok",
            "max_output_tokens": 1024,
        },
    )

print(result)

排队并稍后收集

将相同的请求体发送到 POST https://api.comfy.org/v2/models/openai/o4-mini/requests。运行一旦被受理，Router 就会返回 201 和 request_id；结果就绪后，可从本进程或其他进程收集。队列投递 介绍了状态、取消与收集。

Python

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/o4-mini",
            {
                "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())

​

Schema

​

输入

include · string[]

要包含在模型响应中的额外输出数据。

input · string | object[] · 必填

发送给模型的文本、图像或文件输入，用于生成响应。这是本契约中 Router 无法提供的唯一字段，也是下面 required 中唯一的条目。

instructions · string

将一条 system（或 developer）消息插入模型上下文的第一个位置。

max_output_tokens · integer

一次响应所生成 token 数量的上限，包括可见的输出 token 和推理 token。对于推理类 id，这个上限与隐藏的推理 token 共享，因此较小的值可能在产生任何可见文本之前就耗尽整个预算，这也是推理冒烟用例发送 1024、而对话用例发送 16 的原因。

范围：1 至 …

model · string

OpenAI 模型标识符。在 Comfy Router 上，此字段为可选，Router 会从 {model} 路径段填充它；显式的 null 也会以同样的方式被替换。发送与路径不一致的值会被拒绝。

parallel_tool_calls · boolean

是否允许模型并行执行工具调用。

previous_response_id · string

上一个响应的 ID，用于多轮对话。

reasoning · object

仅限推理层级。推理模型的配置，例如 {"effort": "medium"}。原样转发；可接受的键请参见 OpenAI 的推理指南。对话层级的 id 会忽略它。

store · boolean

OpenAI 是否存储已生成的响应以便日后检索。

stream · boolean

声明该字段是为了让发送它的调用方不被拒绝，但它在此接口上是无效的：Router 会在派发之前将其确定为 false，因为 Router 捕获的是提供商的响应，而不是转发 text/event-stream，而后者它无法解码，因此流式的生成会被 OpenAI 计费，却不会被任何人计量。没有任何 Comfy 接口提供流式传输：v1 的 POST /proxy/openai/v1/responses 入口会以 400 拒绝 stream: true，并且从不上游转发该请求，因此在任一接口上都应省略该字段或发送 false，并将已完成的响应作为单个 JSON 主体读取。

temperature · number

采样温度。仅限对话层级：o 系列推理 id（o1、o1-pro、o3、o4-mini）在 OpenAI 处会拒绝此参数。Router 不会替它们拒绝该参数（关于两个层级为何共用同一 schema，请参见本组件的说明），因此发送该参数的推理调用会由 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

当上下文超出模型窗口时采用的截断策略。与上面三个词表不同，这里的枚举是会被强制校验的，因为这两个值是 OpenAI 文档中记载的完整集合，且没有增加过。显式的 null 仍会被接受，条件与其上方的字段相同。

可能的值：auto、disabled

usage · object

Token 用量封装。该字段出现在本契约中，是因为 v1 操作在请求体上声明了它；OpenAI 会在响应中填充它，因此调用方没有理由发送它。

由 Router 在 GET /v2/models/openai/o4-mini/openapi.json 提供的 schema 生成，也是在请求到达提供商之前用于校验调用的同一份文档。

​

输出

instructions · string

将一条 system（或 developer）消息插入到模型上下文的第一个位置。

与 previous_response_id 一起使用时，上一个响应的 instructions 不会延续到下一个响应。这样在新的响应中替换 system（或 developer）消息就非常简单。

max_output_tokens · integer

响应可生成的 token 数量上限，包括可见的输出 token 和推理 token。

model · string

用于生成该响应的模型

temperature · number · 默认值: "1"

控制响应的随机性

范围：0 到 2

top_p · number · 默认值: "1"

通过核采样控制响应的多样性

范围：0 到 1

truncation · string · 默认值: "\"disabled\""

用于模型响应的截断策略。

• auto：如果本次响应及此前响应的上下文超过模型的上下文窗口大小，模型将通过丢弃对话中间的输入项来截断响应，以适应上下文窗口。

• disabled（默认）：如果模型响应将超过模型的上下文窗口大小，请求将失败并返回 400 错误。

  可能的值：auto、disabled

previous_response_id · string

模型上一个响应的唯一 ID。用它来创建多轮对话。了解更多关于对话状态的信息。

reasoning · object

仅适用于 o 系列模型

推理模型的配置选项。

reasoning.context · string

控制后续轮次中哪些推理项会被渲染回模型，例如 auto、current_turn 或 all_turns。

reasoning.effort · string · 默认值: "\"medium\""

仅适用于 o 系列模型

约束推理模型的推理强度。目前支持的值为 low、medium 和 high。降低推理强度可以加快响应速度，并减少响应中用于推理的 token 数量。

可能的值：low、medium、high

reasoning.generate_summary · string

已弃用： 请改用 summary。

模型所执行推理的摘要。这对于调试和理解模型的推理过程很有用。取值为 auto、concise 或 detailed 之一。

可能的值：auto、concise、detailed

reasoning.mode · string

该响应所使用的推理模式。

reasoning.summary · string

模型所执行推理的摘要。这对于调试和理解模型的推理过程很有用。取值为 auto、concise 或 detailed 之一。

可能的值：auto、concise、detailed

text · object

text.format · object

一个对象，用于指定模型必须输出的格式。

配置 { "type": "json_schema" } 会启用结构化输出，它确保模型会匹配你提供的 JSON schema。更多信息请参阅结构化输出指南。

默认格式为 { "type": "text" }，不带任何附加选项。

不建议用于 gpt-4o 及更新的模型：

设置为 { "type": "json_object" } 会启用较旧的 JSON 模式，它确保模型生成的消息是有效的 JSON。对于支持 json_schema 的模型，优先使用 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

该响应完成时的 Unix 时间戳（以秒为单位）。仅当状态为 completed 时才会出现。

created_at · number

该响应创建时的 Unix 时间戳（以秒为单位）。

error · object

当模型生成响应失败时返回的错误对象。

error.code · 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

error.message · string · 必填

错误的人类可读描述。

frequency_penalty · number

根据 token 在目前文本中已有的出现频率，对新 token 进行惩罚。

id · string

此 Response 的唯一标识符。

incomplete_details · object

关于响应为何不完整的详情。

incomplete_details.reason · string

响应不完整的原因。

可能的值：max_output_tokens, content_filter

max_tool_calls · integer

一次响应中可处理的内置工具调用总次数上限。

metadata · object

可附加到响应上的键值对集合。

moderation · object

响应输入和输出的审核结果（如果请求了经审核的补全）。

object · string

此资源的对象类型，始终设置为 response。

可能的值：response

output · object[]

由模型生成的内容项数组。

• output 数组中各项的长度和顺序取决于 模型的响应。
• 与其访问 output 数组中的第一项，并 假设它是包含模型生成内容的 assistant 消息， 不如考虑使用 SDK 中受支持的 output_text 属性。

output_text · string

仅 SDK 提供的便捷属性，包含来自 output 数组中 所有 output_text 项的聚合文本输出（如果有）。 在 Python 和 JavaScript SDK 中受支持。

parallel_tool_calls · boolean · 默认值: "true"

是否允许模型并行运行工具调用。

presence_penalty · number

根据 token 是否已出现在截至目前文本中，对新 token 进行惩罚。

prompt_cache_key · string

由 OpenAI 用于缓存相似请求的响应，以优化缓存命中率。替代 user 字段。

prompt_cache_retention · string

prompt 缓存的保留策略，例如 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

按内置工具细分的 token 和请求用量。

tool_usage.image_gen · object

图像生成工具的 token 用量。

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

在每个 token 位置上返回的最可能 token 的最大数量，每个 token 都带有关联的对数概率。

usage · object

表示 token 用量详情，包括输入 token、输出 token、 输出 token 的细分以及使用的总 token 数。

usage.input_tokens · integer · 必填

输入 token 的数量。

usage.input_tokens_details · object · 必填

输入 token 的详细细分。

usage.input_tokens_details.cache_write_tokens · integer

写入缓存的输入 token 数量。

usage.input_tokens_details.cached_tokens · integer · 必填

从缓存中检索到的 token 数量。 关于提示缓存的更多信息。

usage.output_tokens · integer · 必填

输出 token 的数量。

usage.output_tokens_details · object · 必填

输出 token 的详细拆分。

usage.output_tokens_details.reasoning_tokens · integer · 必填

推理 token 的数量。

usage.total_tokens · integer · 必填

使用的 token 总数。

user · 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 并在自动重试中复用它。手动重试时，请复用原始 key。Router 最长可保持连接 10 分钟。

请求失败时，Router 会发送 X-Comfy-Error-Type 响应头说明原因。422 表示 Router 在调用提供商之前就拒绝了输入，413 表示请求体超出了 Router 可接受的大小。已生成的资源请及时下载，因为结果 URL 会过期。

上文任何字段描述中提到的尺寸限制，都是提供商对该字段自身的限定，引自提供商的规范。Router 会对整个请求体另行设置上限，base64 编码的媒体内容也计入其中：参见请求体大小。

本页记录的是通过 Comfy Router 调用的某一个合作伙伴模型。同一个 comfy-sdk / @comfyorg/sdk 包还提供第二个客户端，用于在 Comfy Cloud 上运行完整的 ComfyUI 工作流图：Comfy(api_key=...) / new Comfy({ apiKey })，并带有 client.workflows、client.assets 和 client.jobs。请参阅 Comfy SDKs。

请求头

身份验证、幂等性、请求 ID、错误分类、重试节奏、消费限额。

使用 Router API

模型发现、验证错误、重试与计费。

限制

Router 目前不支持的功能，以及替代方案。