Files

Josh Palmer 5676a6b38d Docs: normalize zh-CN terminology + tone

What: switch to 你/你的 tone; standardize Skills/Gateway网关/local loopback/私信 wording
Why: align zh-CN docs with issue 6995 feedback + idiomatic tech style
Tests: pnpm docs:build

2026-02-02 16:38:25 +01:00

7.9 KiB

Raw Blame History

read_when, summary, title, x-i18n

read_when

summary

title

x-i18n

集成使用 OpenResponses API 的客户端

你需要基于 item 的输入、客户端工具调用或 SSE 事件

从 Gateway网关暴露一个兼容 OpenResponses 的 /v1/responses HTTP 端点

OpenResponses API

generated_at	model	provider	source_hash	source_path	workflow
2026-02-01T20:35:34Z	claude-opus-4-5	pi	0597714837f8b210c38eeef53561894220c1473e54c56a5c69984847685d518c	gateway/openresponses-http-api.md	14

OpenResponses API (HTTP)

OpenClaw 的 Gateway网关可以提供一个兼容 OpenResponses 的 POST /v1/responses 端点。

此端点默认禁用。请先在配置中启用。

POST /v1/responses
与 Gateway网关使用相同端口（WS + HTTP 多路复用）：http://<gateway-host>:<port>/v1/responses

底层实现中，请求作为普通的 Gateway网关智能体运行来执行（与 openclaw agent 相同的代码路径），因此路由/权限/配置与你的 Gateway网关一致。

认证

使用 Gateway网关的认证配置。发送 bearer 令牌：

Authorization: Bearer <token>

说明：

当 gateway.auth.mode="token" 时，使用 gateway.auth.token（或 OPENCLAW_GATEWAY_TOKEN）。
当 gateway.auth.mode="password" 时，使用 gateway.auth.password（或 OPENCLAW_GATEWAY_PASSWORD）。

选择智能体

无需自定义头：在 OpenResponses 的 model 字段中编码智能体 ID：

model: "openclaw:<agentId>"（示例："openclaw:main"、"openclaw:beta"）
model: "agent:<agentId>"（别名）

或通过头指定特定的 OpenClaw 智能体：

x-openclaw-agent-id: <agentId>（默认：main）

高级用法：

x-openclaw-session-key: <sessionKey> 完全控制会话路由。

启用端点

将 gateway.http.endpoints.responses.enabled 设置为 true：

{
  gateway: {
    http: {
      endpoints: {
        responses: { enabled: true },
      },
    },
  },
}

禁用端点

将 gateway.http.endpoints.responses.enabled 设置为 false：

{
  gateway: {
    http: {
      endpoints: {
        responses: { enabled: false },
      },
    },
  },
}

会话行为

默认情况下，端点是每次请求无状态的（每次调用生成一个新的会话密钥）。

如果请求包含 OpenResponses 的 user 字符串，Gateway网关会从中派生一个稳定的会话密钥，使重复调用可以共享同一个智能体会话。

请求结构（已支持）

请求遵循 OpenResponses API，使用基于 item 的输入。当前支持：

input：字符串或 item 对象数组。
instructions：合并到系统提示中。
tools：客户端工具定义（函数工具）。
tool_choice：过滤或要求客户端工具。
stream：启用 SSE 流式传输。
max_output_tokens：尽力而为的输出限制（取决于提供商）。
user：稳定的会话路由。

已接受但当前忽略：

max_tool_calls
reasoning
metadata
store
previous_response_id
truncation

Items（输入）

`message`

角色：system、developer、user、assistant。

system 和 developer 附加到系统提示中。
最近的 user 或 function_call_output item 成为"当前消息"。
更早的 user/assistant 消息作为历史上下文包含在内。

`function_call_output`（基于轮次的工具）

将工具结果发送回模型：

{
  "type": "function_call_output",
  "call_id": "call_123",
  "output": "{\"temperature\": \"72F\"}"
}

`reasoning` 和 `item_reference`

为兼容 schema 而接受，但在构建提示时忽略。

工具（客户端函数工具）

通过 tools: [{ type: "function", function: { name, description?, parameters? } }] 提供工具。

如果智能体决定调用工具，响应会返回一个 function_call 输出 item。然后你发送一个包含 function_call_output 的后续请求以继续该轮次。

图片（`input_image`）

支持 base64 或 URL 来源：

{
  "type": "input_image",
  "source": { "type": "url", "url": "https://example.com/image.png" }
}

允许的 MIME 类型（当前）：image/jpeg、image/png、image/gif、image/webp。最大大小（当前）：10MB。

文件（`input_file`）

支持 base64 或 URL 来源：

{
  "type": "input_file",
  "source": {
    "type": "base64",
    "media_type": "text/plain",
    "data": "SGVsbG8gV29ybGQh",
    "filename": "hello.txt"
  }
}

允许的 MIME 类型（当前）：text/plain、text/markdown、text/html、text/csv、 application/json、application/pdf。

最大大小（当前）：5MB。

当前行为：

文件内容被解码并添加到系统提示中，而非用户消息中，因此它是临时的（不会持久化到会话历史中）。
PDF 会被解析提取文本。如果发现的文本很少，前几页会被光栅化为图片并传递给模型。

PDF 解析使用对 Node 友好的 pdfjs-dist 旧版构建（无 worker）。现代 PDF.js 构建需要浏览器 worker/DOM 全局对象，因此不在 Gateway网关中使用。

URL 获取默认值：

files.allowUrl：true
images.allowUrl：true
请求受到保护（DNS 解析、私有 IP 阻止、重定向上限、超时）。

文件和图片限制（配置）

默认值可在 gateway.http.endpoints.responses 下调整：

{
  gateway: {
    http: {
      endpoints: {
        responses: {
          enabled: true,
          maxBodyBytes: 20000000,
          files: {
            allowUrl: true,
            allowedMimes: [
              "text/plain",
              "text/markdown",
              "text/html",
              "text/csv",
              "application/json",
              "application/pdf",
            ],
            maxBytes: 5242880,
            maxChars: 200000,
            maxRedirects: 3,
            timeoutMs: 10000,
            pdf: {
              maxPages: 4,
              maxPixels: 4000000,
              minTextChars: 200,
            },
          },
          images: {
            allowUrl: true,
            allowedMimes: ["image/jpeg", "image/png", "image/gif", "image/webp"],
            maxBytes: 10485760,
            maxRedirects: 3,
            timeoutMs: 10000,
          },
        },
      },
    },
  },
}

省略时的默认值：

maxBodyBytes：20MB
files.maxBytes：5MB
files.maxChars：200k
files.maxRedirects：3
files.timeoutMs：10s
files.pdf.maxPages：4
files.pdf.maxPixels：4,000,000
files.pdf.minTextChars：200
images.maxBytes：10MB
images.maxRedirects：3
images.timeoutMs：10s

流式传输（SSE）

设置 stream: true 以接收服务器发送事件（SSE）：

Content-Type: text/event-stream
每个事件行为 event: <type> 和 data: <json>
流以 data: [DONE] 结束

当前发出的事件类型：

response.created
response.in_progress
response.output_item.added
response.content_part.added
response.output_text.delta
response.output_text.done
response.content_part.done
response.output_item.done
response.completed
response.failed（出错时）

用量

当底层提供商报告令牌计数时，usage 会被填充。

错误

错误使用如下 JSON 对象：

{ "error": { "message": "...", "type": "invalid_request_error" } }

常见情况：

401 缺少/无效的认证
400 无效的请求体
405 错误的方法

示例

非流式：

curl -sS http://127.0.0.1:18789/v1/responses \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'x-openclaw-agent-id: main' \
  -d '{
    "model": "openclaw",
    "input": "hi"
  }'

流式：

curl -N http://127.0.0.1:18789/v1/responses \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'x-openclaw-agent-id: main' \
  -d '{
    "model": "openclaw",
    "stream": true,
    "input": "hi"
  }'

7.9 KiB Raw Blame History Unescape Escape