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

快速开始

在你的 Comfy 工作区中创建一个密钥,并将其导出为 COMFY_API_KEY。Python 和 TypeScript 代码片段使用 Comfy SDK(pip install comfy-sdk 和 npm install @comfyorg/sdk);cURL 代码片段则是通过原始 HTTP 发起同样的调用。 模型 ID: openai/gpt-4.1 端点: POST https://api.comfy.org/v2/models/openai/gpt-4.1
相同的请求体,发送到 POST https://api.comfy.org/v2/models/openai/gpt-4.1/requests。运行一经受理,Router 就会返回 201 和 request_id;结果就绪后即可收集,可以由本进程收集,也可以由另一个进程收集。状态、取消与收集的流程详见队列投递。

Schema

Input

string[]
要包含在模型响应中的额外输出数据。
string | object[]
必填
发送给模型的文本、图像或文件输入,用于生成响应。这是本契约中 Router 无法提供的唯一字段,也是下方 required 中的唯一条目。
string
将系统(或开发者)消息插入为模型上下文中的第一项。
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,而后者它无法解码,所以流式生成会被 OpenAI 计费,却没有任何一方进行计量。没有任何 Comfy 接口提供流式服务:v1 的 POST /proxy/openai/v1/responses 入口会以 400 拒绝 stream: true,并且从不把请求转发到上游,因此在任一接口上都请省略该字段或发送 false,并把已完成的响应作为单个 JSON 正文读取。
number
采样温度。仅对话层级:o 系列推理 id(o1、o1-pro、o3、o4-mini)会在 OpenAI 端拒绝此参数。Router 不会替它们拒绝,原因请参见本组件关于两个层级为何共用同一 schema 的说明,因此发送该参数的推理调用会由 OpenAI 自身的错误来回应。范围:0 到 2
object
输出格式配置,例如用于结构化输出的 {"format": {"type": "json_schema", ...}}。原样转发。
string | object
模型应如何选择使用哪个工具。可以是字符串模式,也可以是指定某个工具的对象。
object[]
模型可以调用的工具定义。Router 不会收窄工具分类;有关可接受的形状,请参阅 OpenAI 的 Responses API 参考。
number
核采样截止值。仅对话层级,适用条款与 temperature 相同。范围:0 到 1
string
上下文超出模型窗口时的截断策略。与上面的三种词汇表不同,这里的枚举确实会被强制执行,因为这两个值就是 OpenAI 记载的完整集合,且至今没有增加。显式的 null 仍会被接受,适用条款与它上面的字段相同。可能的值:auto、disabled
object
Token 用量信封。本契约包含该字段,是因为 v1 操作在请求体上声明了它;OpenAI 是在响应上填充它的,所以调用方没有理由发送它。
本文档根据 Router 在 GET /v2/models/openai/gpt-4.1/openapi.json 提供的 schema 生成,Router 在请求到达提供商之前,正是依据同一份文档来校验调用。

输出

string
将系统(或开发者)消息作为模型上下文中的第一项插入。与 previous_response_id 一起使用时,上一个响应的 instructions 不会被延续到下一个响应。这样可以轻松地在新的响应中替换系统(或开发者)消息。
integer
一个响应可生成的 token 数量上限,包括可见的输出 token 和推理 token。
string
用于生成响应的模型
number
默认值:"1"
控制响应中的随机性范围:0 到 2
number
默认值:"1"
通过核采样控制响应的多样性范围: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。降低推理努力程度可以带来更快的响应,并且响应中用于推理的 token 也会更少。可选值:low、medium、high
string
已弃用: 请改用 summary。模型所执行推理的摘要。这对于调试和理解模型的推理过程很有用。取值为 auto、concise 或 detailed 之一。可选值:auto、concise、detailed
string
用于该响应的推理模式。
string
模型所执行推理的摘要。这对于调试和理解模型的推理过程很有用。取值为 auto、concise 或 detailed 之一。可选值:auto、concise、detailed
object
object
一个对象,用于指定模型必须输出的格式。配置 { "type": "json_schema" } 会启用结构化输出,可确保模型与你提供的 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_found
string
必填
人类可读的错误描述。
number
根据新 token 目前在文本中出现的频率对其进行惩罚。
string
此响应的唯一标识符。
object
关于响应为何不完整的详情。
string
响应不完整的原因。Possible values: max_output_tokens、content_filter
integer
一次响应中可处理的内置工具调用总数上限。
object
可附加到该响应的键值对集合。
object
如果请求了审核补全,则为响应输入和输出的审核结果。
string
此资源的对象类型,始终设置为 response。Possible 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
prompt 缓存的保留策略,例如 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、incomplete
boolean
是否存储该响应,以便之后通过 API 检索。
object
按内置工具细分的 token 和请求用量。
object
图像生成工具的 token 用量。
integer
object
integer
integer
integer
object
integer
integer
integer
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 在调用提供商之前就拒绝了输入,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 目前不支持的功能,以及替代方案。