Chuyển đến nội dung chính
Ứng dụng bên ngoài hiện nên giao tiếp với OpenClaw thông qua giao thức Gateway. Sử dụng Gateway WebSocket và các phương thức RPC khi một script, dashboard, tác vụ CI, tiện ích mở rộng IDE hoặc một tiến trình khác muốn khởi động lượt chạy tác tử, phát trực tuyến sự kiện, chờ kết quả, hủy công việc hoặc kiểm tra tài nguyên Gateway.
Hiện chưa có gói client npm công khai. Đừng thêm tên gói client OpenClaw làm phụ thuộc ứng dụng cho đến khi ghi chú phát hành công bố một gói đã được xuất bản và trang này bao gồm hướng dẫn cài đặt.
Trang này dành cho mã bên ngoài tiến trình OpenClaw. Mã Plugin chạy bên trong OpenClaw nên dùng các đường dẫn con openclaw/plugin-sdk/* đã được tài liệu hóa.

​
Hiện có những gì

Bề mặtTrạng tháiDùng cho
Giao thức GatewaySẵn sàngTruyền tải WebSocket, bắt tay kết nối, phạm vi xác thực, quản lý phiên bản giao thức và sự kiện.
Tham chiếu RPC GatewaySẵn sàngCác phương thức Gateway hiện tại cho tác tử, phiên, tác vụ, mô hình, công cụ, tạo tác và phê duyệt.
openclaw agentSẵn sàngTích hợp script chạy một lần khi gọi ra CLI là đủ.
openclaw messageSẵn sàngGửi tin nhắn hoặc hành động kênh từ script.
Cây mã nguồn chứa công việc gói nội bộ cho một thư viện client trong tương lai, nhưng đó không phải là bề mặt cài đặt công khai. Hãy xem nó là chi tiết triển khai xem trước cho đến khi các gói được xuất bản và quản lý phiên bản.

​
Lộ trình khuyến nghị

  1. Chạy hoặc phát hiện một Gateway.
  2. Kết nối qua giao thức Gateway.
  3. Gọi các phương thức RPC đã được tài liệu hóa từ tham chiếu RPC Gateway.
  4. Ghim phiên bản OpenClaw mà bạn kiểm thử cùng.
  5. Kiểm tra lại tham chiếu RPC khi nâng cấp OpenClaw.
Đối với lượt chạy tác tử, hãy bắt đầu với RPC agent và ghép nó với agent.wait khi bạn cần một kết quả cuối. Đối với trạng thái hội thoại bền vững, hãy dùng các phương thức sessions.*. Đối với tích hợp UI, hãy đăng ký sự kiện Gateway và chỉ kết xuất các nhóm sự kiện mà ứng dụng của bạn hiểu.

​
Mã ứng dụng so với mã Plugin

Dùng Gateway RPC khi mã nằm bên ngoài OpenClaw:
  • Script Node khởi động hoặc quan sát lượt chạy tác tử
  • Tác vụ CI gọi một Gateway
  • dashboard và bảng quản trị
  • tiện ích mở rộng IDE
  • cầu nối bên ngoài không cần trở thành Plugin kênh
  • kiểm thử tích hợp với truyền tải Gateway giả hoặc thật
Dùng Plugin SDK khi mã chạy bên trong OpenClaw:
  • Plugin nhà cung cấp
  • Plugin kênh
  • hook công cụ hoặc vòng đời
  • Plugin harness tác tử
  • trợ giúp runtime đáng tin cậy
Ứng dụng bên ngoài không nên import openclaw/plugin-sdk/*; các đường dẫn con đó dành cho Plugin được OpenClaw tải.

​
Liên quan