跳转到内容

OpenAI 聊天补全 (HTTP)

OpenClaw 的 Gateway 可以服务于一个小型 OpenAI 兼容的聊天补全端点。

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

  • POST /v1/chat/completions
  • 与 Gateway 相同的端口 (WS + HTTP 复用):http://<gateway-host>:<port>/v1/chat/completions

在底层,请求作为正常的 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)。

无需自定义标头:在 OpenAI 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.chatCompletions.enabled 设置为 true

{
gateway: {
http: {
endpoints: {
chatCompletions: { enabled: true }
}
}
}
}

gateway.http.endpoints.chatCompletions.enabled 设置为 false

{
gateway: {
http: {
endpoints: {
chatCompletions: { enabled: false }
}
}
}
}

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

如果请求包含 OpenAI user 字符串,Gateway 会从中派生一个稳定的会话密钥,以便重复调用可以共享代理会话。

设置 stream: true 以接收服务器发送事件 (SSE):

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

非流式:

Terminal window
curl -sS http://127.0.0.1:18789/v1/chat/completions \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Content-Type: application/json' \
-H 'x-openclaw-agent-id: main' \
-d '{
"model": "openclaw",
"messages": [{"role":"user","content":"hi"}]
}'