Responses API
创建一次模型响应。传入文本或图片,生成文本或 JSON 输出;也可以让模型调用你定义的函数工具,或使用服务端执行的联网搜索。
工具调用 Tool Use
工具调用 Tool Use
tools 支持四种工具类型:function、namespace、custom(仅 apply_patch)与 web_search,其他类型不支持。前三种由你在本地执行:模型返回调用请求,你执行后把结果回传;web_search 由服务端执行,无需你处理。函数调用通过 tools 传入 JSON Schema 定义的函数,模型可决定在适当时机调用它们:output 中会包含 function_call item,arguments 是参数的 JSON 字符串:output 原样追加到 input,再追加一条 function_call_output(call_id 必须与 function_call 中的一致),发起下一次请求:tools 中加入 {"type": "web_search"},服务端会先根据输入判断是否需要搜索,需要时执行搜索并把结果注入模型上下文,模型基于搜索结果作答:output 最前面会多出一个 web_search_call item。在 include 中加入 web_search_call.action.sources 可以拿到搜索命中的网页来源:授权
请求头
请求体
使用的模型 ID。本接口当前支持 kimi-k3。
"kimi-k3"
本次请求的输入。传字符串等价于一条 user 消息;传数组时按顺序给出带类型的 item,可包含历史对话、工具调用与工具结果。
顶层系统指令,作为最靠前的指令生效。
为 true 时以 SSE 事件流返回响应。
本次响应最多生成的 Token 数量。kimi-k3 默认为 131072,最大可设置为 1048576。此值为期望返回的 Token 长度,而非输入加输出的总长度。达到上限时 status 为 incomplete,incomplete_details.reason 为 max_output_tokens。
推理相关配置。
输出文本配置。
模型可调用的工具列表。
工具定义,按 type 区分。支持 function、custom(仅 apply_patch)、namespace 与 web_search,其他工具类型不支持。
- 函数工具
- 自定义工具
- 命名空间工具
- 联网搜索工具
控制工具调用行为。取 auto 时由模型自行决定是否调用工具。
auto 要额外返回的字段,仅在使用 web_search 工具时有效。web_search_call.action.sources 返回搜索命中的网页来源;web_search_call.results 返回图片搜索结果。
web_search_call.results, web_search_call.action.sources 上下文缓存标识,同一会话使用相同取值可提升缓存命中率。
用于检测可能违反使用政策的用户的稳定标识符。应为唯一标识每个用户的字符串。建议对用户名或邮箱进行哈希处理以避免发送可识别信息
响应
响应创建成功
一次模型响应。
响应的唯一标识符。
"resp_68f0c1c2d3e4f5a6b7c8d9e0"
response 响应创建时的 Unix 时间戳。
响应结束时的 Unix 时间戳。status 为 completed 或 incomplete 时给出,为 in_progress 或 failed 时是 null。
响应状态。流式的起手快照为 in_progress。
in_progress, completed, incomplete, failed 产生本次响应的模型。
输出 item 数组,顺序为 web_search_call(如有)、reasoning、message、工具调用。
output 数组的元素,按 type 区分。
- 推理
- 消息
- 函数调用
- 自定义工具调用
- 联网搜索调用
本次响应的 Token 用量。
status 为 incomplete 时给出原因。
status 为 failed 时给出错误信息。
工具定义,按 type 区分。支持 function、custom(仅 apply_patch)、namespace 与 web_search,其他工具类型不支持。
- 函数工具
- 自定义工具
- 命名空间工具
- 联网搜索工具
控制工具调用行为。取 auto 时由模型自行决定是否调用工具。
auto 固定为 false。
固定为 false。
固定为 null。
固定为 null。