Skip to content

创建 Response ​

POST/responses

接口说明 ​

使用 Bearer API Key 调用 OpenAI Responses;支持严格 JSON 与 SSE、图片、OCR/看图问答、内联文件、音频输入与音频回答、工具、结构化输出、Reasoning 与 Prompt Cache,成功终态必须包含真实 Usage。

请求 ​

  • 方法:POST

  • 鉴权:Authorization: Bearer ${TOKENFACTORY_API_KEY}

请求头 ​

名称必填值或类型说明
Authorization是Bearer ${TOKENFACTORY_API_KEY}Token Factory API Key
Content-Type是application/json请求体媒体类型

路径参数:无

查询参数:无

请求字段 ​

字段类型必填说明示例或约束
backgroundboolean否官方后台执行开关;允许省略、null 或 false。Token Factory 当前不实现 Responses 后台生命周期,true 会返回 400 invalid_request_error。可为 null
context_managementobject[]否上下文管理配置;允许为 null。可为 null
context_management[].compact_thresholdinteger (int32)否触发自动压缩的非负 Token 阈值;模型支持范围由供应商判断。最小值:0;可为 null
context_management[].typestring父字段存在时必填当前支持 compaction。—
conversationstring 或 object否官方 Conversation 引用;允许为 null,且不能与 previous_response_id 同时使用。 Token Factory 当前未实现 Conversations 生命周期,非 null 会返回 400 invalid_request_error。可为 null;形式:string 或 object
includestring[]否额外响应数据选择;允许为 null。可为 null
inputstring 或 object[]否OpenAI 官方可选的字符串或 Responses 输入项数组;数组项保持开放,可包含文本、图片与内联文件内容块。示例:[{"content":[{"text":"解释图片与文档","type":"input_text"},{"detail":"auto","image_u...;形式:string 或 object[]
input[].acknowledged_safety_checksobject[]否已确认的计算机操作安全检查数组。—
input[].actionobject否Web Search 或 Computer 操作。—
input[].approval_request_idstring否MCP 审批请求 ID。—
input[].approveboolean否是否批准 MCP 调用。—
input[].argumentsstring否函数参数 JSON 字符串。—
input[].authorizationstring否MCP 调用授权值。—
input[].call_idstring否工具调用 ID。—
input[].callerobject否工具调用来源。—
input[].commandobject否Shell 或计算机命令。—
input[].commandsstring[]否命令字符串数组。—
input[].connector_idstring否MCP Connector ID。—
input[].contentstring 或 object[]否消息文本或图片/内联文件内容块数组。示例:[{"text":"解释图片与文档","type":"input_text"},{"detail":"auto","image_url":"data:im...;形式:string 或 object[]
input[].content[].detailstring否输入图片或文件细节级别;接受非空字符串,可用值由供应商判断。最短:1 字符
input[].content[].file_datastring否Base64 data URL 文件内容。—
input[].content[].file_idstring否官方 Files 引用 ID;Token Factory 当前未实现 Files 生命周期,发送即返回 400 invalid_request_error。—
input[].content[].file_urlstring否文件 URL。—
input[].content[].filenamestring否内联文件名。—
input[].content[].image_urlstring否图片 URL 或 data URL。—
input[].content[].prompt_cache_breakpointobject否显式 Prompt Cache 断点。—
input[].content[].textstring否输入文本。示例:"解释图片与文档"
input[].content[].typestring父字段存在且匹配该形式时必填输入内容块类型。示例:"input_text";可选值:"input_text"、"input_image"、"input_file"
input[].encrypted_contentstring否不透明加密上下文。—
input[].idstring否既有输入项 ID。—
input[].namestring否工具或函数名。—
input[].namespacestring否工具命名空间。—
input[].outputobject否工具调用输出。—
input[].pending_safety_checksobject[]否等待确认的计算机操作安全检查数组。—
input[].queriesstring[]否搜索查询字符串数组。—
input[].resultsobject[]否工具调用结果数组。—
input[].rolestring否消息角色。示例:"user"
input[].server_labelstring否MCP Server 标签。—
input[].server_urlstring否MCP Server URL。—
input[].shell_idstring否Shell 会话 ID。—
input[].statusstring否输出项状态。可选值:"in_progress"、"completed"、"incomplete"
input[].summaryobject[]否Reasoning 摘要块数组。—
input[].toolsobject[]否动态发现的工具定义数组。—
input[].typestring否输入项类型。—
instructionsstring否系统级指令字符串。示例:"请准确回答";可为 null
max_output_tokensinteger (int32)否非负最大输出 Token 数,包含可见与 Reasoning Token;模型支持范围由供应商判断。最小值:0;可为 null
max_tool_callsinteger (int32)否单次响应允许处理的内置工具调用总数;官方未规定最小值。可为 null
metadataobject否随 Response 保存的元数据;最多 16 个字符串键值对。可为 null
modelstring否OpenAI 官方可选且提供时不能为 null 的模型 ID;Token Factory 仅在 previous_response_id 或加密上下文能恢复原模型亲和时允许省略,无上下文省略时返回 400 invalid_request_error。示例:"YOUR_MODEL_ID"
moderationobject否输入和输出的 Moderation 配置。可为 null
moderation.modelstring父字段存在时必填Moderation 模型 ID。—
moderation.policyobject否输入和输出的 score/block 策略。—
parallel_tool_callsboolean否是否允许并行工具调用;允许为 null。可为 null
previous_response_idstring否要延续的上一次 Response ID;允许为 null。可为 null
promptobject否官方可复用 Prompt 模板引用;允许为 null。Token Factory 当前未实现远程 Prompt 生命周期,提供带非 null id 的引用会返回 400 invalid_request_error。可为 null
prompt_cache_keystring否Prompt Cache 路由键;允许为 null,最长 64 个字符。示例:"example-cache-key";最长:64 字符;可为 null
prompt_cache_optionsobject否Prompt Cache 选项。—
prompt_cache_options.modestring否缓存断点模式。最短:1 字符
prompt_cache_options.ttlstring否缓存生存时间。最短:1 字符
prompt_cache_retentionstring否已弃用的 Prompt Cache 保留策略;允许为 null。最短:1 字符;可为 null
reasoningobject否Reasoning 设置;允许为 null。示例:{"effort":"high","summary":"auto"};可为 null
reasoning.contextstring否纳入 Reasoning 上下文的范围;允许为 null。最短:1 字符;可为 null
reasoning.effortstring否Reasoning 强度;允许为 null,具体可用值取决于模型。示例:"high";最短:1 字符;可为 null
reasoning.generate_summarystring否已弃用的摘要模式;请改用 summary。允许为 null。最短:1 字符;可为 null
reasoning.modestring否Reasoning 模式;当前官方已知 standard、pro,字符串值域向前兼容。—
reasoning.summarystring否Reasoning 摘要模式;允许为 null。示例:"auto";最短:1 字符;可为 null
safety_identifierstring否非识别性的安全标识;建议使用哈希值,禁止直接发送 PII。最长:64 字符;可为 null
service_tierstring否服务处理等级;允许为 null。最短:1 字符;可为 null
storeboolean否是否存储生成结果;允许为 null。示例:false;可为 null
streamboolean否是否使用 Responses SSE 事件流;省略或 null 等同 false。示例:false;可为 null
stream_optionsobject否仅在 stream=true 时使用的 Responses 流式选项。可为 null
stream_options.include_obfuscationboolean否是否在事件中加入混淆填充字段。—
temperaturenumber否采样温度,范围 0 到 2。最小值:0;最大值:2;可为 null
textobject否结构化文本输出与回答详细程度设置。示例:{"format":{"name":"answer","schema":{"type":"object"},"type":"json_schema"}}
text.formatobject否文本或 JSON 结构化输出格式。示例:{"name":"answer","schema":{"type":"object"},"type":"json_schema"}
text.format.descriptionstring否JSON Schema 说明。—
text.format.namestring否JSON Schema 名称。示例:"answer"
text.format.schemaobject否JSON Schema 定义。示例:
text.format.strictboolean否是否严格遵守 JSON Schema;允许为 null。可为 null
text.format.typestring父字段存在时必填输出格式类型。示例:"json_schema";可选值:"text"、"json_object"、"json_schema"
text.verbositystring否回答详细程度;允许为 null。最短:1 字符;可为 null
tool_choicestring 或 object否工具选择模式或指定工具对象。形式:string 或 object
toolsobject[]否官方 Responses 工具定义数组;未知未来工具字段保持开放。示例:[{"name":"lookup","parameters":{"properties":{},"type":"object"},"type":"func...
top_logprobsinteger (int32)否每个位置返回的候选 Token 数,范围 0 到 20。最小值:0;最大值:20;可为 null
top_pnumber否核采样概率质量,范围 0 到 1。最小值:0;最大值:1;可为 null
truncationstring否上下文截断策略;允许为 null。最短:1 字符;可为 null
userstring否已弃用的终端用户标识;请改用 safety_identifier 与 prompt_cache_key。—

请求报文 ​

媒体类型:application/json

json
{
  "input": [
    {
      "content": [
        {
          "text": "解释图片与文档",
          "type": "input_text"
        },
        {
          "detail": "auto",
          "image_url": "data:image/png;base64,...",
          "type": "input_image"
        },
        {
          "file_data": "data:application/pdf;base64,...",
          "filename": "example.pdf",
          "type": "input_file"
        }
      ],
      "role": "user"
    }
  ],
  "instructions": "请准确回答",
  "model": "YOUR_MODEL_ID",
  "prompt_cache_key": "example-cache-key",
  "reasoning": {
    "effort": "high",
    "summary": "auto"
  },
  "store": false,
  "stream": false,
  "text": {
    "format": {
      "name": "answer",
      "schema": {
        "type": "object"
      },
      "type": "json_schema"
    }
  },
  "tools": [
    {
      "name": "lookup",
      "parameters": {
        "properties": {},
        "type": "object"
      },
      "type": "function"
    }
  ]
}

响应 ​

成功状态:200

响应头 ​

名称值或类型说明
Content-Typeapplication/json 或 text/event-stream响应媒体类型
request-idstringToken Factory 独立生成的平台请求编号;Anthropic 错误体的 request_id 与其相同。
retry-afterstring可选重试等待提示:非负秒数或标准 HTTP 日期。重试前仍需确认请求可安全重复。
x-request-idstringToken Factory 独立生成的平台请求编号,与 request-id 相同。

响应字段 ​

OpenAI Responses 成功终态;官方新增字段保持开放。 下表完整列出当前公开协议明确声明的字段;开放扩展只允许未声明的附加字段,不会放宽已声明字段的必填、类型或枚举约束。

字段类型必填说明示例或约束
backgroundboolean否是否在后台运行;允许为 null。可为 null
completed_atnumber否完成时的 Unix 秒时间戳;未完成时为 null。最小值:0;可为 null
conversationobject否所属 Conversation;允许为 null。可为 null
created_atnumber是Response 创建时间的 Unix 秒时间戳;官方 wire 类型为 number。示例:1787832000;最小值:0
errorobject是失败详情;没有失败时为 null。示例:null;可为 null
idstring是Response ID。示例:"resp_example"
incomplete_detailsobject是未完成详情;状态不是 incomplete 时为 null。示例:null;可为 null
instructionsstring 或 object[]是本次使用的系统/开发者指令;允许为 null。示例:"请准确回答";可为 null;形式:string 或 object[]
instructions[].acknowledged_safety_checksobject[]否已确认的计算机操作安全检查数组。—
instructions[].actionobject否Web Search 或 Computer 操作。—
instructions[].approval_request_idstring否MCP 审批请求 ID。—
instructions[].approveboolean否是否批准 MCP 调用。—
instructions[].argumentsstring否函数参数 JSON 字符串。—
instructions[].authorizationstring否MCP 调用授权值。—
instructions[].call_idstring否工具调用 ID。—
instructions[].callerobject否工具调用来源。—
instructions[].commandobject否Shell 或计算机命令。—
instructions[].commandsstring[]否命令字符串数组。—
instructions[].connector_idstring否MCP Connector ID。—
instructions[].contentstring 或 object[]否消息文本或图片/内联文件内容块数组。形式:string 或 object[]
instructions[].content[].detailstring否输入图片或文件细节级别;接受非空字符串,可用值由供应商判断。最短:1 字符
instructions[].content[].file_datastring否Base64 data URL 文件内容。—
instructions[].content[].file_idstring否官方 Files 引用 ID;Token Factory 当前未实现 Files 生命周期,发送即返回 400 invalid_request_error。—
instructions[].content[].file_urlstring否文件 URL。—
instructions[].content[].filenamestring否内联文件名。—
instructions[].content[].image_urlstring否图片 URL 或 data URL。—
instructions[].content[].prompt_cache_breakpointobject否显式 Prompt Cache 断点。—
instructions[].content[].textstring否输入文本。—
instructions[].content[].typestring父字段存在且匹配该形式时必填输入内容块类型。可选值:"input_text"、"input_image"、"input_file"
instructions[].encrypted_contentstring否不透明加密上下文。—
instructions[].idstring否既有输入项 ID。—
instructions[].namestring否工具或函数名。—
instructions[].namespacestring否工具命名空间。—
instructions[].outputobject否工具调用输出。—
instructions[].pending_safety_checksobject[]否等待确认的计算机操作安全检查数组。—
instructions[].queriesstring[]否搜索查询字符串数组。—
instructions[].resultsobject[]否工具调用结果数组。—
instructions[].rolestring否消息角色。—
instructions[].server_labelstring否MCP Server 标签。—
instructions[].server_urlstring否MCP Server URL。—
instructions[].shell_idstring否Shell 会话 ID。—
instructions[].statusstring否输出项状态。可选值:"in_progress"、"completed"、"incomplete"
instructions[].summaryobject[]否Reasoning 摘要块数组。—
instructions[].toolsobject[]否动态发现的工具定义数组。—
instructions[].typestring否输入项类型。—
max_output_tokensinteger (int32)否本次最大输出 Token 数;允许为 null。最小值:1;可为 null
max_tool_callsinteger (int32)否本次最大内置工具调用数;允许为 null。可为 null
metadataobject是随 Response 返回的元数据;允许为 null。示例:{"request_kind":"documentation_example"};可为 null
modelstring是实际模型 ID。示例:"YOUR_MODEL_ID"
moderationobject否输入与输出 Moderation 结果;官方允许省略或为 null。可为 null
moderation.inputobject父字段存在时必填输入内容的 Moderation 结果或错误。—
moderation.outputobject父字段存在时必填输出内容的 Moderation 结果或错误。—
objectstring是固定为 response。示例:"response";可选值:"response"
outputobject 或 object 或 object 或 object 或 object 或 object 或 object[]是Responses 输出项数组;可为空。示例:[{"content":[{"annotations":[],"logprobs":[],"text":"你好","type":"output_text"...;最少:0 项
output[].contentobject 或 object 或 object[] 或 object 或 object[]匹配该形式时必填文本输出或拒答内容块数组。;Reasoning 正文;官方可省略或为 null。示例:[{"annotations":[],"logprobs":[],"text":"你好","type":"output_text"}];示例:[{"annotations":[],"logprobs":[],"text":"你好","type":"output_text"}];可为 null
output[].content[].annotationsobject[]匹配该形式时必填输出文本注释数组。示例:[]
output[].content[].logprobsobject[]否输出 Token 对数概率数组。示例:[]
output[].content[].logprobs[].logprobnumber父字段存在且匹配该形式时必填Token 对数概率。—
output[].content[].logprobs[].tokenstring父字段存在且匹配该形式时必填Token 文本。—
output[].content[].logprobs[].top_logprobsobject[]否该位置的候选 Token 对数概率数组。—
output[].content[].textstring父字段存在且匹配该形式时必填输出文本。;Reasoning 正文文本。示例:"你好"
output[].content[].typestring父字段存在且匹配该形式时必填固定为 output_text。;固定为 refusal。;未列出的有效内容类型;已知类型使用对应结构。;固定为 reasoning_text。;未列出的有效内容类型;已知类型使用对应结构。示例:"output_text";可选值:"output_text";示例:"output_text";可选值:"refusal";示例:"output_text";最短:1 字符;示例:"output_text";可选值:"reasoning_text";示例:"output_text";最短:1 字符
output[].content[].refusalstring匹配该形式时必填拒答说明。—
output[].idstring匹配该形式时必填输出消息 ID。;Reasoning 项 ID。;Compaction 项 ID。;输出项 ID;官方可省略或为 null。 ;输出项 ID。示例:"msg_example";示例:"msg_example";可为 null;示例:"msg_example"
output[].phasestring否Codex 类模型的中间说明或最终答案阶段;官方可省略。最短:1 字符;可为 null
output[].rolestring匹配该形式时必填固定为 assistant。示例:"assistant";可选值:"assistant"
output[].statusstring匹配该形式时必填输出项状态。;Reasoning 输出项状态;官方可省略或为 null。 ;调用状态;官方可省略或为 null。 ;工具输出项状态;不同类型可省略或为 null。示例:"completed";可选值:"in_progress"、"completed"、"incomplete";示例:"completed";可选值:"in_progress"、"completed"、"incomplete";可为 null;示例:"completed";可选值:"in_progress"、"completed"、"incomplete";可为 null;示例:"completed";可选值:"in_progress"、"completed"、"incomplete";可为 null
output[].typestring匹配该形式时必填固定为 message。;固定为 reasoning。;固定为 compaction。;固定为 function_call。;工具输出项类型。;音频输出类型。;未列出的有效内容类型;已知类型使用对应结构。示例:"message";可选值:"message";示例:"message";可选值:"reasoning";示例:"message";可选值:"compaction";示例:"message";可选值:"function_call";示例:"message";可选值:"additional_tools"、"apply_patch_call"、"apply_patch_call_output"、"code_interpreter_call"、"computer_call"、"computer_call_output"、"custom_tool_call"、"custom_tool_call_output"、"file_search_call"、"function_call_output"、"image_generation_call"、"local_shell_call"、"local_shell_call_output"、"mcp_call"、"mcp_approval_request"、"mcp_approval_response"、"mcp_list_tools"、"program"、"program_output"、"shell_call"、"shell_call_output"、"tool_search_call"、"tool_search_output"、"web_search_call";示例:"message";可选值:"audio"、"output_audio";示例:"message";最短:1 字符
output[].encrypted_contentstring匹配该形式时必填可原样续接的不透明加密上下文。;必须原样续接的不透明加密上下文。可为 null
output[].summaryobject 或 object[]匹配该形式时必填Reasoning 摘要内容块数组。—
output[].summary[].textstring匹配该形式时必填摘要文本。—
output[].summary[].typestring匹配该形式时必填固定为 summary_text。;未列出的有效内容类型;已知类型使用对应结构。可选值:"summary_text";最短:1 字符
output[].created_bystring否创建该项的 actor ID。—
output[].argumentsstring匹配该形式时必填函数参数字符串;官方不保证有效 JSON,也允许空字符串。—
output[].call_idstring匹配该形式时必填客户端回传结果时使用的调用 ID。—
output[].callerobject 或 object 或 object否调用来源;官方可省略或为 null。可为 null;形式:object 或 object 或 object
output[].caller.typestring父字段存在且匹配该形式时必填固定为 direct。;固定为 program。;未列出的有效内容类型;已知类型使用对应结构。可选值:"direct";可选值:"program";最短:1 字符
output[].caller.caller_idstring父字段存在且匹配该形式时必填来源 program 调用 ID。—
output[].namestring匹配该形式时必填函数名。—
output[].namespacestring否函数命名空间;官方可省略或为 null。可为 null
output[].datastring匹配该形式时必填供应商返回的音频数据。最短:1 字符
parallel_tool_callsboolean是是否允许模型并行调用工具。示例:true
previous_response_idstring否上一次 Response ID;允许为 null。可为 null
promptobject否可复用 Prompt 引用;允许为 null。可为 null
prompt_cache_keystring否Prompt Cache 路由键;允许为 null。可为 null
prompt_cache_optionsobject否Prompt Cache 选项。—
prompt_cache_options.modestring否缓存断点模式。最短:1 字符
prompt_cache_options.ttlstring否缓存生存时间。最短:1 字符
prompt_cache_retentionstring否已弃用的 Prompt Cache 保留策略;允许为 null。最短:1 字符;可为 null
reasoningobject否本次实际使用的 Reasoning 设置;允许为 null。可为 null
reasoning.contextstring否纳入 Reasoning 上下文的范围;允许为 null。最短:1 字符;可为 null
reasoning.effortstring否Reasoning 强度;允许为 null,具体可用值取决于模型。最短:1 字符;可为 null
reasoning.generate_summarystring否已弃用的摘要模式;请改用 summary。允许为 null。最短:1 字符;可为 null
reasoning.modestring否Reasoning 模式;当前官方已知 standard、pro,字符串值域向前兼容。—
reasoning.summarystring否Reasoning 摘要模式;允许为 null。最短:1 字符;可为 null
safety_identifierstring否非识别性的安全标识;允许为 null。可为 null
service_tierstring否实际服务处理等级;允许为 null。最短:1 字符;可为 null
statusstring否响应状态;官方可省略或为 null,提供非 null 值时必须是合法状态。示例:"completed";可选值:"cancelled"、"completed"、"failed"、"in_progress"、"incomplete"、"queued";可为 null
temperaturenumber是本次采样温度;允许为 null。示例:1;最小值:0;最大值:2;可为 null
textobject否本次实际使用的文本输出设置;官方可省略。—
text.formatobject否文本或 JSON 结构化输出格式。—
text.format.descriptionstring否JSON Schema 说明。—
text.format.namestring否JSON Schema 名称。—
text.format.schemaobject否JSON Schema 定义。—
text.format.strictboolean否是否严格遵守 JSON Schema;允许为 null。可为 null
text.format.typestring父字段存在时必填输出格式类型。可选值:"text"、"json_object"、"json_schema"
text.verbositystring否回答详细程度;允许为 null。最短:1 字符;可为 null
tool_choicestring 或 object是工具选择模式或指定工具对象。示例:"auto";形式:string 或 object
toolsobject[]是本次可用的工具数组。示例:[]
top_logprobsinteger (int32)否每个位置返回的候选 Token 数;允许为 null。最小值:0;最大值:20;可为 null
top_pnumber是本次核采样概率质量;允许为 null。示例:1;最小值:0;最大值:1;可为 null
truncationstring否上下文截断策略;允许为 null。最短:1 字符;可为 null
usageobject否官方可省略或为 null;Token Factory 对需要计费的可兑现成功终态额外要求可信 Usage,缺失时失败关闭而不会把不完整 2xx 返回给客户端。示例:{"input_tokens":31,"input_tokens_details":{"cache_write_tokens":0,"cached_tok...;可为 null
usage.input_tokensinteger (int32)父字段存在时必填输入 Token 数。示例:31;最小值:0
usage.input_tokens_detailsobject父字段存在时必填输入 Token 分类明细。示例:
usage.input_tokens_details.cache_write_tokensinteger (int32)父字段存在时必填写入 Prompt Cache 的 Token 数。示例:0;最小值:0
usage.input_tokens_details.cached_tokensinteger (int32)父字段存在时必填从 Prompt Cache 读取的 Token 数。示例:0;最小值:0
usage.output_tokensinteger (int32)父字段存在时必填输出 Token 数。示例:9;最小值:0
usage.output_tokens_detailsobject父字段存在时必填输出 Token 分类明细。示例:
usage.output_tokens_details.reasoning_tokensinteger (int32)父字段存在时必填Reasoning Token 数。示例:0;最小值:0
usage.total_tokensinteger (int32)父字段存在时必填输入与输出 Token 总数。示例:40;最小值:0
userstring否已弃用的终端用户标识;允许为 null。可为 null

返回报文 ​

媒体类型:application/json

json
{
  "created_at": 1787832000,
  "error": null,
  "id": "resp_example",
  "incomplete_details": null,
  "instructions": "请准确回答",
  "metadata": {
    "request_kind": "documentation_example"
  },
  "model": "YOUR_MODEL_ID",
  "object": "response",
  "output": [
    {
      "content": [
        {
          "annotations": [],
          "logprobs": [],
          "text": "你好",
          "type": "output_text"
        }
      ],
      "id": "msg_example",
      "role": "assistant",
      "status": "completed",
      "type": "message"
    }
  ],
  "parallel_tool_calls": true,
  "status": "completed",
  "temperature": 1,
  "tool_choice": "auto",
  "tools": [],
  "top_p": 1,
  "usage": {
    "input_tokens": 31,
    "input_tokens_details": {
      "cache_write_tokens": 0,
      "cached_tokens": 0
    },
    "output_tokens": 9,
    "output_tokens_details": {
      "reasoning_tokens": 0
    },
    "total_tokens": 40
  }
}

SSE 返回报文 ​

媒体类型:text/event-stream

允许事件:response.created、response.in_progress、response.queued、response.output_item.*、response.content_part.*、response.output_text.*、response.refusal.*、response.function_call_arguments.*、response.reasoning_summary_part.*、response.reasoning_summary_text.*、response.reasoning_text.*、response.audio.*、response.audio_transcript.*、response.file_search_call.*、response.web_search_call.*、response.image_generation_call.*、response.code_interpreter_call.*、response.mcp_call.*、response.mcp_call_arguments.*、response.custom_tool_call_input.*、response.completed、response.incomplete、response.failed、error

协议终态:response.completed、response.incomplete、response.failed、error

text
event: response.created
data: {"type":"response.created","sequence_number":0,"response":{"id":"resp_example","object":"response","created_at":1787832000,"status":"in_progress","error":null,"incomplete_details":null,"instructions":"请准确回答","metadata":{},"model":"YOUR_MODEL_ID","output":[],"parallel_tool_calls":true,"temperature":1.0,"tool_choice":"auto","tools":[],"top_p":1.0}}

event: response.in_progress
data: {"type":"response.in_progress","sequence_number":1,"response":{"id":"resp_example","object":"response","created_at":1787832000,"status":"in_progress","error":null,"incomplete_details":null,"instructions":"请准确回答","metadata":{},"model":"YOUR_MODEL_ID","output":[],"parallel_tool_calls":true,"temperature":1.0,"tool_choice":"auto","tools":[],"top_p":1.0}}

event: response.output_item.added
data: {"type":"response.output_item.added","sequence_number":2,"output_index":0,"item":{"id":"msg_example","type":"message","status":"in_progress","role":"assistant","content":[]}}

event: response.content_part.added
data: {"type":"response.content_part.added","sequence_number":3,"item_id":"msg_example","output_index":0,"content_index":0,"part":{"type":"output_text","annotations":[],"logprobs":[],"text":""}}

event: response.output_text.delta
data: {"type":"response.output_text.delta","sequence_number":4,"item_id":"msg_example","output_index":0,"content_index":0,"delta":"你好","logprobs":[]}

event: response.output_text.done
data: {"type":"response.output_text.done","sequence_number":5,"item_id":"msg_example","output_index":0,"content_index":0,"text":"你好","logprobs":[]}

event: response.content_part.done
data: {"type":"response.content_part.done","sequence_number":6,"item_id":"msg_example","output_index":0,"content_index":0,"part":{"type":"output_text","annotations":[],"logprobs":[],"text":"你好"}}

event: response.output_item.done
data: {"type":"response.output_item.done","sequence_number":7,"output_index":0,"item":{"id":"msg_example","type":"message","status":"completed","role":"assistant","content":[{"type":"output_text","annotations":[],"logprobs":[],"text":"你好"}]}}

event: response.completed
data: {"type":"response.completed","sequence_number":8,"response":{"id":"resp_example","object":"response","created_at":1787832000,"status":"completed","error":null,"incomplete_details":null,"instructions":"请准确回答","metadata":{},"model":"YOUR_MODEL_ID","output":[{"id":"msg_example","type":"message","status":"completed","role":"assistant","content":[{"type":"output_text","annotations":[],"logprobs":[],"text":"你好"}]}],"parallel_tool_calls":true,"temperature":1.0,"tool_choice":"auto","tools":[],"top_p":1.0,"usage":{"input_tokens":31,"input_tokens_details":{"cached_tokens":0,"cache_write_tokens":0},"output_tokens":9,"output_tokens_details":{"reasoning_tokens":0},"total_tokens":40}}}

只有上方列出的协议终态才表示流正常结束;连接中断不代表请求未执行。若已经收到部分内容,不要无条件重放同一请求。

错误 ​

适用完整地址状态错误码常见触发重试建议动作结果风险
https://api.tokenfactory.cn/v1/responses401invalid_api_keyAuthorization 缺失、Bearer 格式错误、Key 不可用或账户未实名否检查 Bearer API Key、Key 状态与实名状态无
https://api.tokenfactory.cn/v1/responses400model_not_found当前模型不可用否核对模型名称与请求地址;持续出现时联系支持无
https://api.tokenfactory.cn/v1/responses404model_not_found模型不存在、未上架或当前入口不可用否调用模型列表并改用当前入口可用模型无
https://api.tokenfactory.cn/v1/responses404MODEL_ROUTING_PROTOCOL_UNSUPPORTED当前模型不可用否核对模型名称与当前入口的模型列表;持续出现时联系支持无
https://api.tokenfactory.cn/v1/responses503MODEL_ROUTING_NOT_CONFIGURED当前模型服务不可用视情况稍后重试;持续出现时提供平台请求编号联系支持无
https://api.tokenfactory.cn/v1/responses503MODEL_ROUTING_POLICY_INVALID当前模型服务不可用视情况稍后重试;持续出现时提供平台请求编号联系支持无
https://api.tokenfactory.cn/v1/responses503MODEL_ROUTING_NO_AVAILABLE_ROUTE当前模型服务不可用否提供平台请求编号联系支持,确认服务恢复后再发送无
https://api.tokenfactory.cn/v1/responses429insufficient_balance账户可用余额不足否充值后重新发起请求无
https://api.tokenfactory.cn/v1/responses429balance_daily_limit_exceeded账户当天余额消费已达到自助上限否调整每日上限或等待次日恢复无
https://api.tokenfactory.cn/v1/responses413request_too_large请求体超过平台接收上限否缩小请求体后重试无
https://api.tokenfactory.cn/v1/responses400invalid_request_error请求参数或请求体缺字段、格式错误或不受支持否修正请求后重试无
https://api.tokenfactory.cn/v1/responses502upstream_error服务响应异常,请稍后重试视情况确认未收到有效结果后再决定是否重试中到高
https://api.tokenfactory.cn/v1/responses504upstream_timeout请求处理超时,请稍后重试视情况先确认是否已有部分输出,再决定是否重试中到高
https://api.tokenfactory.cn/v1/responses500internal_error平台内部出现未预期错误视情况确认未收到有效结果并记录请求时间后再决定是否重试中到高
https://api.tokenfactory.cn/v1/responses405method_not_allowed请求方法不是该公开地址允许的方法否改用文档列出的 HTTP 方法无
https://api.tokenfactory.cn/v1/responses415unsupported_media_typeContent-Type 与该公开地址要求的媒体类型不一致否按文档发送正确 Content-Type无
https://api.tokenfactory.cn/v1/responses403permission_denied当前 API Key 无权执行该请求否检查 API Key 权限与当前入口的模型可见性无
https://api.tokenfactory.cn/v1/responses409conflict_error请求与当前资源状态冲突视情况读取最新状态后修正请求或稍后重试中到高
https://api.tokenfactory.cn/v1/responses422unprocessable_entity请求结构正确但当前请求无法处理否按错误信息修正参数或输入内容无
https://api.tokenfactory.cn/v1/responses503service_unavailable服务暂不可用,请稍后重试视情况保留平台请求编号,稍后重试或联系支持中到高
https://api.tokenfactory.cn/v1/responses503service_busy模型服务繁忙,请稍后重试视情况参考 Retry-After 并限制重试次数;已收到输出时先确认是否可安全重复中到高
https://api.tokenfactory.cn/v1/responses400context_length_exceeded输入超过模型上下文限制否缩短输入或减少历史上下文后再发送无
https://api.tokenfactory.cn/v1/responses400missing_required_parameter缺少必填请求参数否按文档补齐错误指出的公开参数后再发送无
https://api.tokenfactory.cn/v1/responses400invalid_parameter请求参数的类型或格式不正确否修正错误指出的公开参数类型或格式后再发送无
https://api.tokenfactory.cn/v1/responses502upstream_usage_missing服务响应缺少可验证的用量信息视情况保留平台请求编号联系支持;确认可安全重复后再发送中到高

错误返回报文 ​

适用完整地址 ​

https://api.tokenfactory.cn/v1/responses

HTTP 400;Content-Type: application/json;响应头:request-id: string、retry-after: string、x-request-id: string

json
{
  "error": {
    "code": "model_not_found",
    "message": "当前模型不可用",
    "param": null,
    "type": "invalid_request_error"
  }
}

适用完整地址:https://api.tokenfactory.cn/v1/responses

供应商非 2xx 响应会归一化为当前公开协议的错误信封,并只保留安全响应头;502、504 或连接中断时,调用结果可能未知。

限制与计费 ​

适用完整地址限制或计费说明
https://api.tokenfactory.cn/v1/responses请求成功后按通用余额计费;余额不足时调用失败。
受全局请求体上限约束。
模型上下文与输出限制依当前模型和上游事实而定。
支持文本、图片/OCR/看图问答、内联文件、Tools、Structured Output、Reasoning 和 Prompt Cache。
不支持 file_id/Files 生命周期、background、Conversations 资源、WebSocket 或独立 Realtime。

相关说明 ​

请求与响应按当前 OpenAI 兼容能力开放;供应商扩展字段可能随所选模型变化。

TokenFactory 词元工厂 · 开发者文档 · 返回官网