openai/o3 的 API 参考,由 Comfy Router 从 OpenAI 提供。
输入: 文本, 图像 · 输出: 文本
快速开始
在你的 Comfy 工作区中创建一个密钥,并将其导出为COMFY_API_KEY。Python 和 TypeScript 代码片段使用 Comfy SDK(pip install comfy-sdk 和 npm install @comfyorg/sdk);cURL 代码片段则是通过原生 HTTP 发起的相同调用。
模型 ID: openai/o3
端点: POST https://api.comfy.org/v2/models/openai/o3
- 等待结果
- 排队并稍后收集
相同的请求体,发送到
POST https://api.comfy.org/v2/models/openai/o3/requests。运行被受理后,Router 会立即返回 201 和 request_id;结果就绪后即可收集,无论是本进程还是其他进程。队列投递介绍了状态、取消与收集的完整流程。Schema
输入
一次响应所生成 token 数量的上限,包括可见输出 token 与推理 token。在推理类 id 上,该上限与隐藏的推理 token 共享,因此一个较小的值可能在产生任何可见文本之前就耗尽整个预算,这也是推理类冒烟用例发送 1024 而聊天类用例发送 16 的原因。范围:
1 到 …OpenAI 模型标识符。在 Comfy Router 上该字段为可选,Router 会用
{model} 路径段填充它;显式的 null 也以同样的方式被替换。发送与路径不一致的值会被拒绝。声明该字段只是为了让发送它的调用方不被拒绝,但它在本接口上是无效的:Router 会在分发之前将其置为
false,因为它捕获的是提供商响应,而不是转发 text/event-stream,而后者它无法解码,所以流式生成会被 OpenAI 计费,却不会被任何人计量。没有任何 Comfy 接口会提供流:v1 的 POST /proxy/openai/v1/responses 入口会以 400 拒绝 stream: true,并且绝不会把请求转发到上游,因此在任一接口上都应省略该字段或发送 false,并把已完成响应作为单个 JSON 体读取。采样温度。仅限聊天层级:o 系列推理 id(
o1、o1-pro、o3、o4-mini)会在 OpenAI 处拒绝该参数。Router 不会替它们拒绝它(原因见本组件关于两个层级共用同一 schema 的说明),因此发送该参数的推理调用会得到 OpenAI 自身错误的回应。范围:0 到 2上下文超出模型窗口时的截断策略。与上面的三个词表不同,这里的枚举是被强制校验的,因为这两个值就是 OpenAI 文档所载的完整集合,且至今没有扩展。显式的
null 仍然可接受,条件与其上方的字段相同。可选值:auto、disabledGET /v2/models/openai/o3/openapi.json 提供的 schema 生成,它也是 Router 在请求到达提供商之前用于校验调用的同一份文档。
输出
将一条 system(或 developer)消息插入到模型上下文的第一项。与
previous_response_id 一起使用时,上一个 response 中的 instructions
不会延续到下一个 response。这样可以方便地在新的 response 中替换
system(或 developer)消息。一个 response 可生成的 token 数量上限,包括可见的输出 token 和 reasoning token。
用于模型 response 的截断策略。
-
auto:如果当前 response 及之前 response 的上下文超过 模型的上下文窗口大小,模型将通过丢弃对话中间部分的输入项 来截断 response,以适应该上下文窗口。 -
disabled(默认):如果模型 response 将超过该模型的上下文 窗口大小,请求将失败并返回 400 错误。 可选值:auto、disabled
模型上一个 response 的唯一 ID。用它来
创建多轮对话。了解更多关于
对话状态的内容。
仅限 o 系列模型reasoning 模型
的配置选项。
仅限 o 系列模型约束 reasoning 模型
的 reasoning 投入程度。
目前支持的值为
low、medium 和 high。降低
reasoning 投入程度可以加快响应速度,并减少 response 中
用于 reasoning 的 token 数量。可选值:low、medium、high已弃用: 请改用
summary。模型所执行 reasoning 的摘要。这对于
调试和理解模型的 reasoning 过程很有用。
取值为 auto、concise 或 detailed 之一。可选值:auto、concise、detailed模型所执行 reasoning 的摘要。这对于
调试和理解模型的 reasoning 过程很有用。
取值为
auto、concise 或 detailed 之一。可选值:auto、concise、detailed一个对象,用于指定模型必须输出的格式。配置
{ "type": "json_schema" } 会启用 Structured Outputs,
以确保模型符合你提供的 JSON schema。在
Structured Outputs 指南中了解更多。默认格式为 { "type": "text" },且不带任何额外选项。不推荐用于 gpt-4o 及更新的模型:设置为 { "type": "json_object" } 会启用较旧的 JSON 模式,该模式
可确保模型生成的消息是有效的 JSON。对于支持 json_schema
的模型,优先使用它。response 的错误代码。可选值:
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模型生成的内容项数组。
output数组中各项的长度和顺序取决于模型的响应。- 与其访问
output数组中的第一项并假定它是包含模型生成内容的assistant消息,不如考虑在 SDK 支持的情况下使用output_text属性。
响应生成的状态。为
completed、failed、in_progress、cancelled、queued 或 incomplete 之一。可选值:completed、failed、in_progress、cancelled、queued、incomplete从缓存中检索到的 token 数量。
了解关于提示缓存的更多信息。
示例
输入
输出
发布前须知
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 目前不支持的功能,以及替代方案。