openai/o1 的 API 参考文档,由 Comfy Router 从 OpenAI 提供。
快速开始
在你的 Comfy 工作区中创建一个密钥,并将其导出为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
- Wait for the result
- Queue and collect later
Schema
Input
string[]
要包含在模型响应中的额外输出数据。
string | object[]
必填
提供给模型的文本、图像或文件输入,用于生成响应。这是 Router 无法提供的唯一字段,也是下方
required 中唯一的条目。string
将一条系统(或开发者)消息插入为模型上下文中的第一项。
integer
为响应生成的 token 数量上限,包括可见的输出 token 和推理 token。在推理类 id 上,该上限与隐藏的推理 token 共享,因此较小的值可能在产生任何可见文本之前就耗尽整个预算,这就是推理冒烟用例发送 1024、而 chat 用例发送 16 的原因。范围:
1 到 …string
OpenAI 模型标识符。在 Comfy Router 上该字段为可选,Router 会从
{model} 路径段填充它;显式的 null 也会以同样方式替换。发送与路径不一致的值会被拒绝。boolean
是否允许模型并行运行工具调用。
string
上一个响应的 ID,用于多轮对话。
object
仅限推理层级。推理模型的配置,例如
{"effort": "medium"}。原样转发;可接受的键请参阅 OpenAI 的推理指南。chat 层级的 id 会忽略它。boolean
OpenAI 是否存储已生成的响应以供后续检索。
boolean
声明该字段是为了让发送它的调用方不被拒绝,但它在此接口上不生效:Router 会在分发之前将其固定为
false,因为它捕获的是提供商响应,而不是转发 text/event-stream,而 openAiResponsesProxy 的 ModifyResponse 无法解码该响应,因此流式生成会被 OpenAI 计费却无人计量。如果需要流式,请使用 POST /proxy/openai/v1/responses。number
采样温度。仅限 chat 层级:o 系列推理 id(
o1、o1-pro、o3、o4-mini)在 OpenAI 会拒绝该参数。Router 不会代它们拒绝,关于两个层级为何共用同一个 schema 的说明见本组件的注释,因此发送该参数的推理调用会由 OpenAI 自身的错误作答。范围:0 到 2object
输出格式配置,例如用于 Structured Outputs 的
{"format": {"type": "json_schema", ...}}。原样转发。string | object
模型应如何选择使用哪个工具。可以是字符串模式,也可以是命名某个工具的对象。
object[]
模型可以调用的工具定义。Router 不会收窄工具分类;可接受的形状请参阅 OpenAI 的 Responses API 参考。
number
核采样截断值。仅限 chat 层级,条款与
temperature 相同。范围:0 到 1string
当上下文超出模型窗口时采用的截断策略。与上面的三个词表不同,这里的枚举是强制校验的,因为这两个值是 OpenAI 记录的完整集合,而且一直没有增加。显式的
null 仍然可以接受,条款与上面的字段相同。可能的值:auto、disabledobject
token 用量信封。该契约中出现它,是因为 v1 操作在请求体上声明了它;OpenAI 是在响应中填充它,因此调用方没有理由发送它。
GET /v2/models/openai/o1/openapi.json 提供的 schema 生成,请求到达提供商之前,Router 会依据同一份文档校验调用。
输出
string
插入一条系统(或开发者)消息,作为模型上下文中的第一条内容。当与
previous_response_id 一起使用时,上一个响应的 instructions
不会延续到下一个响应。这样可以轻松地在新的响应中替换
系统(或开发者)消息。string
用于生成响应的模型
number
默认值:"1"
控制响应的随机性范围:
0 到 2number
默认值:"1"
通过核采样(nucleus sampling)控制响应的多样性范围:
0 到 1string
默认值:"\"disabled\""
用于模型响应的截断策略。
-
auto:如果本次响应及之前响应的上下文超过 模型的上下文窗口大小,模型将截断 响应以适应上下文窗口,方式是丢弃对话 中间的输入项。 -
disabled(默认):如果模型响应将超过模型的 上下文窗口大小,请求将失败并返回 400 错误。 可选值:auto、disabled
string
控制在后续轮次中哪些推理项会被回传给模型,例如
auto、current_turn 或 all_turns。string
默认值:"\"medium\""
仅 o 系列模型约束推理模型的
推理投入程度。
目前支持的值为
low、medium 和 high。降低
推理投入可以带来更快的响应,以及响应中用于
推理的 token 更少。可选值:low、medium、highstring
已弃用: 请改用
summary。模型所执行推理的摘要。这对于
调试和理解模型的推理过程很有用。
可取 auto、concise 或 detailed。可选值:auto、concise、detailedstring
用于该响应的推理模式。
string
模型所执行推理的摘要。这对于
调试和理解模型的推理过程很有用。
可取
auto、concise 或 detailed。可选值:auto、concise、detailedobject
object
一个用于指定模型必须输出的格式的对象。配置
{ "type": "json_schema" } 可启用结构化输出
(Structured Outputs),这能确保模型匹配你提供的 JSON schema。在
结构化输出指南中了解更多。默认格式为 { "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
此响应完成时的 Unix 时间戳(以秒为单位)。仅当状态为
completed 时出现。number
此响应创建时的 Unix 时间戳(以秒为单位)。
object
模型无法生成响应时返回的错误对象。
string
必填
该响应的错误代码。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_foundstring
必填
对错误的人类可读描述。
number
根据新 token 在目前已生成文本中出现的频率对其进行惩罚。
string
此 Response 的唯一标识符。
object
关于响应为何不完整的详情。
string
响应不完整的原因。Possible values:
max_output_tokens, content_filterinteger
一次响应中可处理的内置工具调用总次数的上限。
object
可附加到该响应的一组键值对。
object
响应输入和输出的审核结果(如果请求了审核补全)。
string
此资源的对象类型,始终设置为
response。Possible values: responseobject[]
模型生成的内容项数组。
output数组中各项的长度和顺序取决于模型的响应。- 与其访问
output数组中的第一项并假设它是包含模型生成 内容的assistant消息,不如考虑使用 SDK 中受支持的output_text属性。
string
仅 SDK 提供的便捷属性,包含
output 数组中所有 output_text 项聚合后的文本输出
(如果存在)。在 Python 和 JavaScript SDK 中受支持。boolean
默认值:"true"
是否允许模型并行运行工具调用。
number
根据新 token 是否已在目前已生成的文本中出现对其进行惩罚。
string
由 OpenAI 用于缓存相似请求的响应,以优化缓存命中率。替代
user 字段。string
提示缓存的保留策略,例如
in_memory 或 24h。string
用于帮助检测可能违反 OpenAI 使用政策的应用用户的稳定标识符。
string
用于处理请求的处理层级,例如
auto、default、flex、scale 或 priority。string
响应生成的状态。为
completed、failed、in_progress、cancelled、queued 或 incomplete 之一。Possible values: completed, failed, in_progress, cancelled, queued, incompleteboolean
响应是否会被存储以便之后通过 API 检索。
object
按内置工具细分的 token 和请求用量。
object
图像生成工具的 token 用量。
integer
object
integer
integer
integer
object
integer
integer
integer
object
搜索工具用量。
integer
integer
在每个 token 位置返回的最可能 token 的最大数量,每个都附带相关的对数概率。
object
表示 token 用量详情,包括输入 token、输出 token、
输出 token 的细分以及使用的总 token 数。
integer
必填
输入 token 的数量。
object
必填
输入 token 的详细细分。
integer
写入缓存的输入 token 数量。
integer
必填
输出 token 的数量。
object
必填
输出 token 的详细明细。
integer
必填
推理 token 的数量。
integer
必填
使用的 token 总数。
string
已弃用的最终用户标识符。已替换为
safety_identifier 和 prompt_cache_key。示例
输入
输出
发布前须知
SDK 会生成Idempotency-Key 并在自动重试中复用它。手动重试时,请复用原始 key。Router 最长可保持连接 10 分钟。
请求失败时,Router 会发送 X-Comfy-Error-Type 响应头说明原因。422 表示 Router 在调用提供商之前就拒绝了输入。生成的资源请及时下载,因为结果链接会过期。
请求头
身份验证、幂等性、请求 ID、错误分类、重试节奏、消费限额。
使用 Router API
模型发现、校验错误、重试与计费。
限制
Router 目前不支持的功能,以及替代方案。