跳轉到主要內容
外部應用程式目前應透過閘道協定與 OpenClaw 通訊。當指令碼、儀表板、CI 作業、IDE 擴充功能或其他程序想要啟動代理程式執行、串流事件、等待結果、取消工作，或檢查閘道資源時，請使用閘道 WebSocket 和 RPC 方法。
目前還沒有公開的 npm 用戶端套件。在發行說明宣布已發布套件且本頁包含安裝指示之前，請不要將 OpenClaw 用戶端套件名稱加入應用程式依賴項。
本頁適用於 OpenClaw 程序外部的程式碼。在 OpenClaw 內部執行的外掛程式碼，應改用已文件化的 openclaw/plugin-sdk/* 子路徑。

​
目前可用的內容

介面狀態用途
閘道協定就緒WebSocket 傳輸、連線交握、驗證範圍、協定版本控管和事件。
閘道 RPC 參考就緒目前用於代理程式、工作階段、任務、模型、工具、成品和核准的閘道方法。
openclaw agent就緒當透過 shell 呼叫命令列介面已足夠時，用於一次性指令碼整合。
openclaw message就緒從指令碼傳送訊息或頻道動作。
原始碼樹包含未來用戶端函式庫的內部套件工作，但那不是公開的安裝介面。在套件發布並版本化之前，請將其視為預覽實作細節。

​
建議路徑

  1. 執行或探索閘道。
  2. 透過閘道協定連線。
  3. 呼叫閘道 RPC 參考中已文件化的 RPC 方法。
  4. 固定你測試所依據的 OpenClaw 版本。
  5. 升級 OpenClaw 時重新檢查 RPC 參考。
對於代理程式執行，請從 agent RPC 開始，並在需要終端結果時搭配 agent.wait。對於持久的對話狀態，請使用 sessions.* 方法。對於 UI 整合，請訂閱閘道事件，並只呈現你的應用程式理解的事件系列。

​
應用程式碼與外掛程式碼

當程式碼位於 OpenClaw 外部時，請使用閘道 RPC：
  • 啟動或觀察代理程式執行的節點指令碼
  • 呼叫閘道的 CI 作業
  • 儀表板和管理面板
  • IDE 擴充功能
  • 不需要成為頻道外掛的外部橋接器
  • 使用假的或真正的閘道傳輸進行整合測試
當程式碼在 OpenClaw 內部執行時，請使用外掛 SDK：
  • 提供者外掛
  • 頻道外掛
  • 工具或生命週期鉤子
  • 代理程式執行框架外掛
  • 受信任的執行階段輔助工具
外部應用程式不應匯入 openclaw/plugin-sdk/*；這些子路徑是供 OpenClaw 載入的外掛使用。

​
相關