openai/gpt-4o 的 API 参考文档,由 Comfy Router 从 OpenAI 提供。
快速开始
在你的 Comfy 工作区中创建一个密钥,并将其导出为COMFY_API_KEY。Python 和 TypeScript 代码片段使用 Comfy SDK(pip install comfy-sdk、npm install @comfyorg/sdk);cURL 代码片段则通过原始 HTTP 发起同样的调用。
Model ID: openai/gpt-4o
Endpoint: POST https://api.comfy.org/v2/models/openai/gpt-4o
- Wait for the result
- Queue and collect later
Schema
输入
string[]
要包含在模型响应中的额外输出数据。
string | object[]
必填
提供给模型的文本、图像或文件输入,用于生成响应。这是本契约中 Router 无法提供的唯一字段,也是下方
required 中唯一的条目。string
在模型上下文的最前面插入一条 system(或 developer)消息。
integer
为响应生成的 token 数量上限,包含可见输出 token 和推理 token。在推理类 id 上,这一上限与隐藏的推理 token 共享,因此较小的值可能在产生任何可见文本之前就耗尽全部预算:这正是推理冒烟用例发送 1024、而聊天用例发送 16 的原因。范围:
1 到 …string
OpenAI 模型标识符。在 Comfy Router 上该字段为可选,Router 会从
{model} 路径段填充它;显式的 null 也会以同样的方式被替换。发送与路径不一致的值会被拒绝。boolean
是否允许模型并行执行工具调用。
string
上一个响应的 ID,用于多轮对话。
object
仅限推理层级。推理模型的配置,例如
{"effort": "medium"}。原样转发;可接受的键请参阅 OpenAI 的推理指南。聊天层级的 id 会忽略它。boolean
OpenAI 是否存储已生成的响应以便之后检索。
boolean
声明此字段是为了让发送它的调用方不被拒绝,但它在此接口上是无效的:Router 会在派发之前将其固定为
false,因为它捕获的是提供商的响应,而不是转发 text/event-stream。openAiResponsesProxy 的 ModifyResponse 无法解码该流,因此流式生成会被 OpenAI 计费,却无人计量。如果你需要流式传输,请使用 POST /proxy/openai/v1/responses。number
采样温度。仅限聊天层级:o 系列推理 id(
o1、o1-pro、o3、o4-mini)在 OpenAI 处会拒绝该参数。Router 不会替它们拒绝,参见本组件关于两个层级为何共用同一 Schema 的说明。因此,发送该参数的推理调用会收到 OpenAI 自身的错误。范围:0 到 2object
输出格式配置,例如用于结构化输出的
{"format": {"type": "json_schema", ...}}。原样转发。string | object
模型应如何选择使用哪个工具。可以是字符串模式,也可以是指定某个工具的对象。
object[]
模型可以调用的工具定义。Router 不会收窄工具分类;可接受的形状请参阅 OpenAI 的 Responses API 参考。
number
核采样截断值。仅限聊天层级,条件与
temperature 相同。范围:0 到 1string
当上下文超出模型窗口时采用的截断策略。与上方三个词表不同,这里的枚举是强制执行的,因为这两个值是 OpenAI 文档中的完整集合,且至今没有扩充。显式的
null 仍被接受,条件与其上方的字段相同。可能的值:auto、disabledobject
token 用量封装。该契约中存在此字段,是因为 v1 操作在请求体上声明了它;OpenAI 是在响应中填充它,因此调用方没有理由发送它。
GET /v2/models/openai/gpt-4o/openapi.json 提供的 Schema 生成,这也是它在请求到达提供商之前用于校验调用的同一份文档。
输出
string
将系统(或开发者)消息作为第一个条目插入模型的上下文中。当与
previous_response_id 一起使用时,上一个响应中的指令不会延续到下一个响应。这样可以轻松地在新的响应中替换系统(或开发者)消息。string
用于生成响应的模型
number
默认值:"1"
控制响应的随机性范围:
0 到 2number
默认值:"1"
通过核采样控制响应的多样性范围:
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
此 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_foundstring
必填
人类可读的错误描述。
number
根据 token 在当前文本中已有的出现频率对新 token 进行惩罚。
string
此 Response 的唯一标识符。
object
关于响应为何不完整的详情。
string
响应不完整的原因。可能的值:
max_output_tokens、content_filterinteger
一次响应中可处理的内置工具调用总数上限。
object
可附加到响应的键值对集合。
object
如果请求了审核后的补全,则为响应输入和输出的审核结果。
string
此资源的对象类型,始终设置为
response。可能的值:responseobject[]
由模型生成的内容项数组。
output数组中各项的长度和顺序取决于模型的响应。- 与其访问
output数组中的第一项并假设它是包含模型生成内容的assistant消息, 不如在 SDK 支持的情况下考虑使用output_text属性。
string
仅 SDK 提供的便捷属性,包含
output 数组中所有 output_text 项的
聚合文本输出(如果有)。Python 和 JavaScript SDK
支持。boolean
默认值:"true"
是否允许模型并行运行工具调用。
number
根据新 token 是否已出现在当前文本中对其进行惩罚。
string
OpenAI 用于缓存相似请求的响应以优化缓存命中率。替代
user 字段。string
prompt 缓存的保留策略,例如
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、incompleteboolean
是否存储响应以便稍后通过 API 检索。
object
按内置工具细分的 token 和请求用量。
object
图像生成工具的 token 用量。
integer
object
integer
integer
integer
object
integer
integer
integer
object
Web 搜索工具的用量。
integer
integer
在每个 token 位置返回的最可能 token 的最大数量,每个 token 都附带关联的对数概率。
object
表示 token 用量详情,包括输入 token、输出 token、
输出 token 的细分以及使用的总 token 数。
integer
必填
输入 token 的数量。
object
必填
输入 token 的详细细分。
integer
写入缓存的输入 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 目前不支持的功能,以及替代方案。