OpenResponses API

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 相符。

驗證、安全性和路由

操作行為符合 OpenAI Chat Completions：

使用 Authorization: Bearer <token> 搭配正常的 Gateway 驗證設定
將此端點視為對於 gateway 執行個體的完整操作員存取權
對於共享金鑰驗證模式（token 和 password），忽略較狹窄的 bearer 宣告 x-openclaw-scopes 值，並恢復正常的完整運算子預設值
對於可信任的身分承載 HTTP 模式（例如可信任的 Proxy 驗證或 gateway.auth.mode="none"），仍然遵守請求上宣告的運算子範圍
使用 model: "openclaw"、model: "openclaw/default"、model: "openclaw/<agentId>" 或 x-openclaw-agent-id 選擇代理程式
當您想要覆寫所選代理程式的後端模型時，請使用 x-openclaw-model
使用 x-openclaw-session-key 進行明確的會話路由
當您想要非預設的合成入口通道上下文時，請使用 x-openclaw-message-channel

驗證矩陣：

gateway.auth.mode="token" 或 "password" + Authorization: Bearer ...
- 證明擁有共享的 Gateway 運算子金鑰
- 忽略較狹窄的 x-openclaw-scopes
- 恢復完整的預設運算子範圍集
- 將此端點上的聊天回合視為擁有者-發送者回合
可信任的身分承載 HTTP 模式（例如可信任的 Proxy 驗證，或私人入口上的 gateway.auth.mode="none"）
- 遵守宣告的 x-openclaw-scopes 標頭
- 僅當 operator.admin 實際存在於那些宣告的範圍中時，才獲得擁有者語意

使用 gateway.http.endpoints.responses.enabled 啟用或停用此端點。

相同的相容性層級也包括：

GET /v1/models
GET /v1/models/{id}
POST /v1/embeddings
POST /v1/chat/completions

關於代理程式目標模型、openclaw/default、嵌入直通以及後端模型覆寫如何協同運作的規範說明，請參閱 OpenAI Chat Completions 和模型列表與代理程式路由。

會話行為

根據預設，該端點是每次請求無狀態的（每次呼叫都會產生新的會話金鑰）。

如果請求包含 OpenResponses user 字串，閘道會從中衍生出一個穩定的 session 金鑰，因此重複呼叫可以共享一個 agent session。

請求形狀（已支援）

請求遵循採用基於項目輸入的 OpenResponses API。目前支援：

input：字串或項目物件陣列。
instructions：合併到系統提示中。
tools：用戶端工具定義（函式工具）。
tool_choice：過濾或要求用戶端工具。
stream：啟用 SSE 串流。
max_output_tokens：盡力而為的輸出限制（取決於供應商）。
user：穩定的 session 路由。

已接受但目前忽略：

max_tool_calls
reasoning
metadata
store
truncation

已支援：

previous_response_id：當請求保持在相同的 agent/使用者/請求 session 範圍內時，OpenClaw 會重用先前的回應 session。

項目（輸入）

`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? } }] 提供工具。

如果 agent 決定呼叫工具，回應會傳回 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 全域變數，因此未在 Gateway 中使用。

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"（不符合頂層網域）
- 空白或省略的允許清單表示沒有主機名稱允許清單限制。
若要完全停用基於 URL 的取得，請設定 files.allowUrl: false 和/或 images.allowUrl: false。

檔案 + 圖像限制 (設定)

預設值可以在 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 (發生錯誤時)

使用量

當底層提供者回報 token 計數時，會填入 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"
  }'