Skip to main content
openai/gpt-5 的 API 参考文档,由 Comfy Router 从 OpenAI 提供。

快速开始

你的 Comfy 工作区中创建一个密钥,并将其导出为 COMFY_API_KEY。Python 和 TypeScript 代码片段使用 Comfy SDK(pip install comfy-sdknpm install @comfyorg/sdk);cURL 代码片段是通过原始 HTTP 发起的相同调用。 模型 ID: openai/gpt-5 端点: POST https://api.comfy.org/v2/models/openai/gpt-5

Schema

输入

string[]
要包含在模型响应中的额外输出数据。
string | object[]
必填
提供给模型的文本、图像或文件输入,用于生成响应。这是本契约中 Router 无法提供的唯一字段,也是下方 required 中唯一的条目。
string
插入一条 system(或 developer)消息,作为模型上下文中的第一项。
integer
一次响应所生成 token 数量的上限,包含可见的输出 token 与推理 token。在 reasoning 类 id 上,这个上限会与隐藏的推理 token 共享,因此一个很小的值可能会在任何可见文本出现之前就耗尽整个预算。这也是为什么 reasoning 冒烟用例发送 1024,而 chat 用例只发送 16。范围:1
string
OpenAI 模型标识符。在 Comfy Router 上,该字段是可选的,Router 会用 {model} 路径段填充它;显式的 null 也会以同样方式被替换。发送与路径不一致的值会被拒绝。
boolean
是否允许模型并行执行工具调用。
string
上一个响应的 ID,用于多轮对话。
object
仅限 REASONING 层级。推理模型的配置,例如 {"effort": "medium"}。原样转发;可接受的键请参阅 OpenAI 的推理指南。chat 层级的 id 会忽略它。
boolean
OpenAI 是否存储已生成的响应以便日后检索。
boolean
声明该字段是为了让发送它的调用方不被拒绝,但在此接口上是无效的:Router 会在分发之前将它固定为 false,因为这里捕获的是提供商响应,而不是转发 text/event-stream,而 openAiResponsesProxy 的 ModifyResponse 无法解码它,因此流式生成会被 OpenAI 计费,却不会有任何一方进行计量。如果你需要流式传输,请使用 POST /proxy/openai/v1/responses
number
采样温度。仅限 CHAT 层级:o 系列 reasoning id(o1o1-proo3o4-mini)在 OpenAI 侧会拒绝该参数。Router 不会替它们拒绝,原因参见本组件中关于两个层级为何共用一份 schema 的说明。因此,发送该参数的 reasoning 调用会由 OpenAI 自身的错误来回应。范围:02
object
输出格式配置,例如用于 Structured Outputs 的 {"format": {"type": "json_schema", ...}}。原样转发。
string | object
模型应如何选择使用哪个工具。可以是字符串模式,也可以是指定某个工具的对象。
object[]
模型可以调用的工具定义。Router 不会收窄工具的类别范围;可接受的形状请参阅 OpenAI 的 Responses API 参考文档。
number
核采样截断值。仅限 CHAT 层级,适用条件与 temperature 相同。范围:01
string
当上下文超出模型窗口时的截断策略。与上述三组词汇表不同,这里的枚举值确实会被强制执行,因为这两个值就是 OpenAI 文档所记载的完整集合,且至今没有扩充。显式的 null 仍然会被接受,适用条件与它上方的字段相同。可能的值:autodisabled
object
Token 用量信封。该字段之所以出现在本契约中,是因为 v1 操作在请求体上声明了它;OpenAI 是在响应中填充它,因此调用方没有理由发送它。
根据 Router 在 GET /v2/models/openai/gpt-5/openapi.json 所提供的 schema 生成,该文档也正是它在请求到达提供商之前用于校验调用的同一份文档。

输出

string
将系统(或开发者)消息作为模型上下文中的第一项插入。当与 previous_response_id 一起使用时,上一条响应中的指令不会延续到下一条响应。这使得在新的响应中替换系统(或开发者)消息变得简单。
integer
响应可生成 token 数量的上限,包括可见的输出 token 和推理 token
string
用于生成响应的模型
number
默认值:"1"
控制响应的随机性范围:02
number
默认值:"1"
通过核采样控制响应的多样性范围:01
string
默认值:"\"disabled\""
用于模型响应的截断策略。
  • auto:如果当前响应和之前响应的上下文超过模型上下文窗口大小,模型将通过丢弃对话中间的输入项来截断响应以适应上下文窗口。
  • disabled(默认):如果模型响应将超过模型的上下文窗口大小,请求将失败并返回 400 错误。 可选值:autodisabled
string
模型上一条响应的唯一 ID。使用此参数创建多轮对话。了解更多关于对话状态的内容。
object
仅 o 系列模型推理模型的配置选项。
string
控制后续轮次中哪些推理项会被回传给模型,例如 autocurrent_turnall_turns
string
默认值:"\"medium\""
仅 o 系列模型约束推理模型的推理努力程度。目前支持的值有 lowmediumhigh。降低推理努力程度可以使响应更快,并减少响应中用于推理的 token 数量。可选值:lowmediumhigh
string
已弃用: 请改用 summary模型所执行推理的摘要。这对于调试和理解模型的推理过程非常有用。取值为 autoconcisedetailed 之一。可选值:autoconcisedetailed
string
用于响应的推理模式。
string
模型所执行推理的摘要。这对于调试和理解模型的推理过程非常有用。取值为 autoconcisedetailed 之一。可选值:autoconcisedetailed
object
object
一个指定模型必须输出格式的对象。配置 { "type": "json_schema" } 可启用结构化输出,确保模型匹配你提供的 JSON schema。在结构化输出指南中了解更多。默认格式为 { "type": "text" },不带任何附加选项。不推荐用于 gpt-4o 及更新模型:设置为 { "type": "json_object" } 可启用较旧的 JSON 模式,确保模型生成的消息是有效的 JSON。对于支持它的模型,优先使用 json_schema
string
约束模型响应的详细程度。取值为 lowmediumhigh 之一。
`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_found
string
必填
错误的可读描述。
number
根据文本中已出现的新 token 的频率对其进行惩罚。
string
此 Response 的唯一标识符。
object
关于响应不完整原因的详情。
string
响应不完整的原因。Possible values: max_output_tokens, content_filter
integer
单次响应中可处理的内置工具总调用次数上限。
object
可附加到该响应的一组键值对。
object
响应输入和输出的审核结果(如果请求了审核补全)。
string
此资源的对象类型,始终设置为 responsePossible values: response
object[]
模型生成的内容项数组。
  • output 数组中各项的长度和顺序取决于模型的响应。
  • 与其访问 output 数组中的第一项并假定它是包含模型生成 内容的 assistant 消息,不如考虑使用 SDK 中支持的 output_text 属性。
string
仅 SDK 提供的便捷属性,包含 output 数组中所有 output_text 项聚合后的文本输出(如果存在)。Python 和 JavaScript SDK 均支持。
boolean
默认值:"true"
是否允许模型并行运行工具调用。
number
根据新 token 是否已在文本中出现过对其进行惩罚。
string
由 OpenAI 用于缓存相似请求的响应,以优化缓存命中率。取代 user 字段。
string
提示缓存的保留策略,例如 in_memory24h
string
一个稳定的标识符,用于帮助检测可能违反 OpenAI 使用政策的应用程序用户。
string
用于处理请求的处理层级,例如 autodefaultflexscalepriority
string
响应生成的状态。取值为 completedfailedin_progresscancelledqueuedincomplete 之一。Possible values: completed, failed, in_progress, cancelled, queued, incomplete
boolean
是否存储该响应以便之后通过 API 检索。
object
按内置工具细分的 token 和请求使用情况。
object
图像生成工具的 token 使用情况。
integer
object
integer
integer
integer
object
integer
integer
integer
网络搜索工具的使用情况。
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_identifierprompt_cache_key 替换。

示例

输入

输出

发布前须知

SDK 会生成 Idempotency-Key 并在自动重试中复用它。手动重试时,请复用原始 key。Router 最长可保持连接 10 分钟。 请求失败时,Router 会发送 X-Comfy-Error-Type 响应头说明原因。422 表示 Router 在调用提供商之前就拒绝了输入。生成的资源请及时下载,因为结果链接会过期

请求头

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

使用 Router API

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

限制

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