OpenAI 聊天補全

閘道可以提供一個小型、與 OpenAI 相容的 Chat Completions 介面。此介面預設為停用。

啟用後，以下所有端點都會在與閘道相同的連接埠上提供服務（WS + HTTP 多工）：

方法	路徑
POST	/v1/chat/completions
GET	/v1/models
GET	/v1/models/{id}
POST	/v1/embeddings
POST	/v1/responses

請求會以一般的閘道代理程式執行方式運作（與 openclaw agent 使用相同的程式碼路徑），因此路由、權限和設定皆與你的閘道一致。

​

啟用端點

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

將 enabled: false 設定為停用值（或省略）即可停用。

​

安全性邊界（重要）

請將此端點視為對閘道執行個體的完整操作員存取權：

• 此端點的有效閘道權杖／密碼等同於擁有者／操作員認證資訊，而非範圍受限的個別使用者權限。
• 請求會經由與受信任操作員動作相同的控制平面代理程式路徑執行，因此若目標代理程式的政策允許使用敏感工具，此端點也能使用這些工具。
• 請僅將其置於回送介面／tailnet／私人入口。請勿將其公開至網際網路。

驗證矩陣：

驗證路徑	行為
gateway.auth.mode="token" 或 "password" + Authorization: Bearer ...	證明呼叫者持有共用閘道密鑰。忽略任何 x-openclaw-scopes 標頭，並恢復完整的預設操作員權限範圍集合：operator.admin、operator.approvals、operator.pairing、operator.read、operator.talk.secrets、operator.write。將聊天輪次視為擁有者傳送者的輪次。
帶有受信任身分的 HTTP（受信任 Proxy 驗證，或私人入口上的 gateway.auth.mode="none"）	若存在 x-openclaw-scopes，便遵循其設定；若不存在，則退回使用預設操作員權限範圍集合。只有在呼叫者明確縮限權限範圍且省略 operator.admin 時，才會失去擁有者語意。若要使用 x-openclaw-model 等擁有者層級的控制功能，必須具備 operator.admin。

請參閱操作員權限範圍、安全性和遠端存取。

​

驗證

使用閘道的驗證設定（該模式的詳細資訊請參閱受信任 Proxy 驗證）：

模式	驗證方式
gateway.auth.mode="token"	Authorization: Bearer <token>。透過 gateway.auth.token 或 OPENCLAW_GATEWAY_TOKEN 設定。
gateway.auth.mode="password"	Authorization: Bearer <password>。透過 gateway.auth.password 或 OPENCLAW_GATEWAY_PASSWORD 設定。
gateway.auth.mode="trusted-proxy"	經由已設定的身分感知 Proxy 路由；該 Proxy 會注入必要的身分標頭。同一主機上的回送 Proxy 需要明確設定 gateway.auth.trustedProxy.allowLoopback = true。
gateway.auth.mode="none"	不需要驗證標頭（僅限私人入口）。

注意事項：

• 在 trusted-proxy 閘道上略過 Proxy 的同一主機呼叫者，可以直接退回使用 gateway.auth.password／OPENCLAW_GATEWAY_PASSWORD。任何 Forwarded、X-Forwarded-* 或 X-Real-IP 標頭證據都會讓請求繼續使用受信任 Proxy 路徑。
• 若已設定 gateway.auth.rateLimit，且驗證失敗次數過多，端點會傳回 429，並附帶 Retry-After 標頭。

​

何時使用此端點

• 當你的整合只是同一閘道的另一個操作員／用戶端介面時，應優先使用此端點，而非新增內建通道。
• 對於直接連線至遠端閘道的原生行動用戶端，應優先使用 WebChat 或採用配對裝置啟動程序／裝置權杖流程的閘道通訊協定，如此裝置便不需要共用 HTTP 權杖／密碼。
• 若要整合擁有自己使用者、聊天室、網路鉤子傳遞或輸出傳輸機制的外部訊息網路，則應改為建置通道外掛。請參閱建置外掛。

​

代理程式優先的模型合約

OpenClaw 將 OpenAI 的 model 欄位視為代理程式目標，而非原始供應商模型 ID。

model 值	路由至
openclaw	已設定的預設代理程式
openclaw/default	已設定的預設代理程式（穩定別名；即使實際的預設代理程式 ID 在不同環境間有所變更，也可安全地寫死此值）
openclaw/<agentId> 或 openclaw:<agentId>	特定代理程式
agent:<agentId>	特定代理程式（相容性別名）

選用的請求標頭：

標頭	效果
x-openclaw-model: <provider/model-or-bare-id>	覆寫所選代理程式的後端模型。使用共用密鑰的不記名呼叫者可以直接使用此標頭；帶有身分的呼叫者（受信任 Proxy，或具有 x-openclaw-scopes 的私人免驗證入口）需要 operator.admin，否則為 403 missing scope: operator.admin。
x-openclaw-agent-id: <agentId>	用於選取代理程式的相容性覆寫。
x-openclaw-session-key: <sessionKey>	明確的工作階段路由。若使用保留的內部命名空間（subagent:、cron:、acp:），則會以 400 invalid_request_error 拒絕。
x-openclaw-message-channel: <channel>	設定合成的入口通道情境，用於可感知通道的提示詞／政策。

/v1/models 會列出頂層代理程式目標（openclaw、openclaw/default、openclaw/<agentId>），而非後端供應商模型或子代理程式；子代理程式仍屬於內部執行拓撲。若省略 x-openclaw-model，所選代理程式會使用其一般設定的模型執行。

/v1/embeddings 使用相同的代理程式目標 model ID。傳送 x-openclaw-model（來自共用密鑰呼叫者，或具有 operator.admin 的帶身分呼叫者）即可選擇特定的嵌入模型；否則請求會使用所選代理程式的一般嵌入設定。

​

工作階段行為

端點預設每個請求皆無狀態（每次呼叫都會產生新的工作階段金鑰）。

如果請求包含 OpenAI user 字串，閘道會從中衍生穩定的工作階段金鑰，讓重複呼叫可以共用代理程式工作階段。對於自訂應用程式，請為每個對話討論串重複使用相同的 user 值；除非你希望多個對話／裝置共用同一個 OpenClaw 工作階段，否則請避免使用帳戶層級識別碼。只有在需要跨多個用戶端／討論串進行明確的路由控制時，才使用 x-openclaw-session-key，並採用由應用程式自行管理且避開上述保留命名空間的金鑰。

​

請求限制

此端點使用以下內建限制：每個請求本文 20 MB、最新使用者訊息中的 8 個 image_url 部分，以及累計 20 MB 的已解碼圖片資料。圖片來源政策仍可在 gateway.http.endpoints.chatCompletions.images 下設定：

{
  gateway: {
    http: {
      endpoints: {
        chatCompletions: {
          enabled: true,
          images: {
            allowUrl: false,
            urlAllowlist: ["cdn.example.com", "*.assets.example.com"],
            allowedMimes: [
              "image/jpeg",
              "image/png",
              "image/gif",
              "image/webp",
              "image/heic",
              "image/heif",
            ],
            maxBytes: 10485760,
            maxRedirects: 3,
            timeoutMs: 10000,
          },
        },
      },
    },
  },
}

圖片設定的預設值如下：

金鑰	預設值
images.allowUrl	false（除非啟用，否則會拒絕來自 URL 的 image_url 部分）
images.maxBytes	每張圖片 10MB
images.maxRedirects	3
images.timeoutMs	10s

HEIC/HEIF image_url 來源會被接受，並在透過共用 OpenClaw 圖片處理器（Rastermill）傳遞給供應商之前正規化為 JPEG；對於需要外部編解碼器支援的格式，該處理器會退回使用系統轉換器（sips、ImageMagick、GraphicsMagick 或 ffmpeg）。

安全性注意事項：將主機名稱加入允許清單並不會略過私人／內部 IP 封鎖。對於公開至網際網路的閘道，除了應用程式層級的防護措施外，也應套用網路輸出控制。請參閱安全性。

​

聊天工具合約

/v1/chat/completions 支援與常見 OpenAI Chat 用戶端相容的函式工具子集。

​

支援的請求欄位

欄位	備註
tools	{ "type": "function", "function": { ... } } 的陣列
tool_choice	"auto"、"none"、"required" 或 { "type": "function", "function": { "name": "..." } }
messages[*].role: "tool"	後續輪次
messages[*].tool_call_id	將工具結果繫結回先前的工具呼叫
max_completion_tokens	數字；每次呼叫的完成權杖總數上限（包括推理權杖）。目前的欄位名稱；當此欄位與 max_tokens 同時傳送時使用此欄位。
max_tokens	數字；舊版別名，當 max_completion_tokens 也存在時會被忽略。
temperature	0-2 的數字；盡力處理，並轉送至上游供應商。超出範圍時為 400 invalid_request_error。
top_p	0-1 的數字；盡力處理。超出範圍時為 400 invalid_request_error。
frequency_penalty	-2.0 至 2.0 的數字；盡力處理。超出範圍時為 400 invalid_request_error。
presence_penalty	-2.0 至 2.0 的數字；盡力處理。超出範圍時為 400 invalid_request_error。
seed	整數；盡力處理。非整數值為 400 invalid_request_error。
stop	字串或最多包含 4 個字串的陣列；盡力處理。超過 4 個序列，或包含非字串／空白項目時為 400 invalid_request_error。

所有取樣與權杖上限欄位都透過相同的代理程式串流參數通道傳遞，並以盡力方式轉送：

• 權杖上限：傳輸欄位名稱由供應商傳輸層選擇：OpenAI 系列端點使用 max_completion_tokens，僅接受舊版名稱的供應商（Mistral、Chutes）使用 max_tokens。
• stop 會對應至傳輸層的停止欄位：Chat Completions 後端使用 stop，Anthropic 使用 stop_sequences。OpenAI Responses API 沒有停止參數，因此 stop 不會套用至以 Responses 為後端的模型。
• 以 ChatGPT 為基礎的 Codex Responses 後端使用固定的伺服器端取樣，並在請求抵達該後端前移除 temperature/top_p（以及 max_output_tokens、metadata、prompt_cache_retention、service_tier）。

​

不支援的變體

以下情況會傳回 400 invalid_request_error：

• 非陣列的 tools、非函式的工具項目，或缺少 tool.function.name
• tool_choice 變體，例如 allowed_tools 和 custom
• 與所提供工具不相符的 tool_choice.function.name 值

對於 tool_choice: "required" 和鎖定函式的 tool_choice，端點會縮小向客戶端公開的函式工具集合、指示執行階段在回應前呼叫客戶端工具，並在代理程式回應中沒有相符的結構化客戶端工具呼叫時回報錯誤。這適用於呼叫者提供的 HTTP tools 清單，而非 OpenClaw 代理程式的每個內部工具。

​

非串流工具回應格式

代理程式呼叫工具時，回應會使用：

• choices[0].finish_reason = "tool_calls"
• 包含 id、type: "function"、function.name、function.arguments（JSON 字串）的 choices[0].message.tool_calls[] 項目
• 工具呼叫前的助理註解，位於 choices[0].message.content（可能為空）

​

串流工具回應格式

當 stream: true 時，工具呼叫會以遞增 SSE 區塊送達：初始的助理角色差異、選用的助理註解差異、一或多個攜帶工具識別資訊與引數片段的 delta.tool_calls 區塊，接著是包含 finish_reason: "tool_calls" 和 data: [DONE] 的最終區塊。

如果 stream_options.include_usage=true，則會在 [DONE] 前送出尾隨的用量區塊。

​

工具後續迴圈

收到 tool_calls 後，執行要求的函式，並傳送後續請求，其中包含先前的助理工具呼叫訊息，以及一或多個具有相符 tool_call_id 的 role: "tool" 訊息。這會繼續相同的代理程式推理迴圈，以產生最終答案。

​

串流（SSE）

設定 stream: true 以接收伺服器傳送事件：

• Content-Type: text/event-stream
• 每個事件行為 data: <json>
• 串流以 data: [DONE] 結束

​

Open WebUI 快速設定

• 基底 URL：http://127.0.0.1:18789/v1
• macOS 上 Docker 的基底 URL：http://host.docker.internal:18789/v1
• API 金鑰：你的閘道持有者權杖
• 模型：openclaw/default

預期行為：GET /v1/models 會列出 openclaw/default，而 Open WebUI 會將其用作聊天模型 ID。若要使用特定的後端供應商／模型，請設定代理程式的一般預設模型，或傳送 x-openclaw-model（共用密鑰呼叫者，或具有 operator.admin 的身分識別呼叫者）。

快速冒煙測試：

curl -sS http://127.0.0.1:18789/v1/models \
  -H 'Authorization: Bearer YOUR_TOKEN'

如果傳回 openclaw/default，大多數 Open WebUI 設定都能使用相同的基底 URL 和權杖連線。

​

範例

單一應用程式對話的穩定工作階段：

curl -sS http://127.0.0.1:18789/v1/chat/completions \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "model": "openclaw/default",
    "user": "conv:YOUR_CONVERSATION_ID",
    "messages": [{"role":"user","content":"摘要我今天的工作"}]
  }'

在該對話的後續呼叫中重複使用相同的 user 值，以繼續相同的代理程式工作階段。

非串流：

curl -sS http://127.0.0.1:18789/v1/chat/completions \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "model": "openclaw/default",
    "messages": [{"role":"user","content":"嗨"}]
  }'

串流：

curl -N http://127.0.0.1:18789/v1/chat/completions \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'x-openclaw-model: openai/gpt-5.4' \
  -d '{
    "model": "openclaw/research",
    "stream": true,
    "messages": [{"role":"user","content":"嗨"}]
  }'

列出模型：

curl -sS http://127.0.0.1:18789/v1/models \
  -H 'Authorization: Bearer YOUR_TOKEN'

擷取單一模型：

curl -sS http://127.0.0.1:18789/v1/models/openclaw%2Fdefault \
  -H 'Authorization: Bearer YOUR_TOKEN'

建立嵌入向量：

curl -sS http://127.0.0.1:18789/v1/embeddings \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'x-openclaw-model: openai/text-embedding-3-small' \
  -d '{
    "model": "openclaw/default",
    "input": ["alpha", "beta"]
  }'

/v1/embeddings 支援將 input 設為字串或字串陣列。

​

相關資源

• 設定參考
• 操作者範圍
• OpenAI