Skip to main content
openai/gpt-4.1-nano 的 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-nano 端点: POST https://api.comfy.org/v2/models/openai/gpt-4.1-nano
将相同的请求体发送到 POST https://api.comfy.org/v2/models/openai/gpt-4.1-nano/requests。只要运行被受理,Router 就会立即返回 201 和 request_id;结果就绪后,即可从本进程或其他进程收集。排队投递 介绍了状态查询、取消和结果收集。

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,而后者它无法解码,因此流式生成会被 OpenAI 计费却无人计量。没有任何 Comfy 接口提供该流:v1 POST /proxy/openai/v1/responses 入口会以 400 拒绝 stream: true,并且绝不会将请求转发到上游,因此在任一接口上都应省略该字段或发送 false,并把已完成的响应作为一个 JSON 响应体读取。
number
采样温度。仅限对话层级:在 OpenAI 处,o 系列推理 id(o1、o1-pro、o3、o4-mini)会拒绝该参数。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-nano/openapi.json 提供的 schema 生成,这也是它在请求到达提供商之前用于校验调用的同一份文档。

输出

string
将一条系统(或开发者)消息插入为模型上下文中的第一项。与 previous_response_id 一起使用时,上一个响应中的指令不会延续到下一个响应。这使得在新的响应中替换系统(或开发者)消息变得很简单。
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 的模型,优先使用 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
必填
该响应的错误代码。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 在目前文本中已有的出现频率对新 token 进行惩罚。
string
此 Response 的唯一标识符。
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 是否已在目前文本中出现来对新 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
网页搜索工具的用量。
integer
integer
在每个 token 位置上返回的最可能 token 的最大数量,每个 token 都带有对应的对数概率。
object
表示 token 用量详情,包括输入 token、输出 token、输出 token 的细分以及使用的总 token 数。
integer
必填
输入 token 的数量。
object
必填
输入 token 的详细细分。
integer
写入缓存的输入 token 数量。
integer
必填
从缓存中检索到的 token 数量。 关于提示缓存(prompt caching)的更多内容。
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 目前不支持的功能,以及替代方案。