协议与 API

OpenResponses API

OpenClaw 的网关可以提供一个兼容 OpenResponses 的 POST /v1/responses 端点。此端点默认禁用。请先在配置中启用它。

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

在底层，请求作为正常的网关代理运行执行（与 openclaw agent 相同的代码路径），因此路由/权限/配置与您的网关匹配。

身份验证

使用网关的身份验证配置。发送承载令牌：

Authorization: Bearer <token>

注意事项：

当 gateway.auth.mode="token" 时，使用 gateway.auth.token（或 OPENCLAW_GATEWAY_TOKEN）
当 gateway.auth.mode="password" 时，使用 gateway.auth.password（或 OPENCLAW_GATEWAY_PASSWORD）
如果配置了 gateway.auth.rateLimit 且身份验证失败次数过多，端点将返回 429 并附带 Retry-After

安全边界（重要）

将此端点视为网关实例的完全操作员访问接口。

此处的 HTTP 承载身份验证不是细粒度的每用户范围模型
此端点的有效网关令牌/密码应被视为所有者/操作员凭据
请求通过与控制平面代理路径相同的受信任操作员操作路径运行
此端点上没有独立的非所有者/每用户工具边界；一旦调用者在此通过网关身份验证，OpenClaw 就将该调用者视为此网关的受信任操作员
如果目标代理策略允许敏感工具，此端点可以使用它们
请仅将此端点保留在环回/Tailnet/私有入口上；不要直接将其暴露给公共互联网

请参阅安全性和远程访问。

选择代理

无需自定义标头：在 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 字符串，网关会从中派生出稳定的会话密钥，因此重复调用可以共享一个代理会话。

请求格式（支持的）

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

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

已接受但当前被忽略：

max_tool_calls
reasoning
metadata
store
previous_response_id
truncation

项目（输入）

message

角色：system, developer, user, assistant。

system 和 developer 会附加到系统提示中
最近的 user 或 function_call_output 项目成为"当前消息"
更早的用户/助手消息会作为历史上下文包含在内

function_call_output（基于回合的工具）

将工具结果发送回模型：

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

reasoning 和 item_reference

为模式兼容性而接受，但在构建提示时被忽略。

工具（客户端函数工具）

通过 tools: [{ type: "function", function: { name, description?, parameters? } }] 提供工具。如果代理决定调用工具，响应将返回一个 function_call 输出项目。然后您需要发送一个包含 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, image/heic, image/heif。最大大小（当前）：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 全局变量，因此未在网关中使用。URL 获取默认值：

files.allowUrl: true
images.allowUrl: true
maxUrlParts: 8（每个请求中基于 URL 的 input_file + input_image 部分总数）
请求受到保护（DNS 解析、私有 IP 阻止、重定向上限、超时）
支持按输入类型配置可选的主机名允许列表（files.urlAllowlist, images.urlAllowlist）
- 精确主机："cdn.example.com"
- 通配符子域名："*.assets.example.com"（不匹配根域名）

文件 + 图像限制（配置）

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

{
  gateway: {
    http: {
      endpoints: {
        responses: {
          enabled: true,
          maxBodyBytes: 20000000,
          maxUrlParts: 8,
          files: {
            allowUrl: true,
            urlAllowlist: ["cdn.example.com", "*.assets.example.com"],
            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,
            urlAllowlist: ["images.example.com"],
            allowedMimes: [
              "image/jpeg",
              "image/png",
              "image/gif",
              "image/webp",
              "image/heic",
              "image/heif",
            ],
            maxBytes: 10485760,
            maxRedirects: 3,
            timeoutMs: 10000,
          },
        },
      },
    },
  },
}

省略时的默认值：

maxBodyBytes: 20MB
maxUrlParts: 8
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
HEIC/HEIF input_image 源被接受，并在交付给提供商之前被规范化为 JPEG

安全说明：

URL 允许列表在获取之前和重定向跳转时强制执行
允许列表中的主机名不会绕过私有/内部 IP 阻止
对于暴露在互联网上的网关，除了应用级防护外，还应应用网络出口控制。请参阅安全性

流式传输（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"
  }'

OpenAI 聊天补全工具调用 API