RPC and API
Integrasi Gateway untuk aplikasi eksternal
Aplikasi eksternal sebaiknya berkomunikasi dengan OpenClaw melalui protokol Gateway saat ini. Gunakan WebSocket Gateway dan metode RPC saat skrip, dasbor, pekerjaan CI, ekstensi IDE, atau proses lain ingin memulai eksekusi agen, mengalirkan peristiwa, menunggu hasil, membatalkan pekerjaan, atau memeriksa sumber daya Gateway.
Yang tersedia saat ini
| Permukaan | Status | Gunakan untuk |
|---|---|---|
| Protokol Gateway | Siap | Transport WebSocket, handshake koneksi, cakupan auth, versioning protokol, dan peristiwa. |
| Referensi RPC Gateway | Siap | Metode Gateway saat ini untuk agen, sesi, tugas, model, alat, artefak, dan persetujuan. |
openclaw agent |
Siap | Integrasi skrip sekali jalan saat menjalankan CLI dari shell sudah cukup. |
openclaw message |
Siap | Mengirim pesan atau tindakan kanal dari skrip. |
Pohon sumber berisi pekerjaan paket internal untuk pustaka klien mendatang, tetapi itu bukan permukaan instalasi publik. Perlakukan sebagai detail implementasi pratinjau sampai paket tersebut dipublikasikan dan diberi versi.
Jalur yang direkomendasikan
- Jalankan atau temukan Gateway.
- Hubungkan melalui protokol Gateway.
- Panggil metode RPC terdokumentasi dari referensi RPC Gateway.
- Sematkan versi OpenClaw yang Anda uji.
- Periksa ulang referensi RPC saat memutakhirkan OpenClaw.
Untuk eksekusi agen, mulai dengan RPC agent dan pasangkan dengan agent.wait saat
Anda memerlukan hasil terminal. Untuk status percakapan yang tahan lama, gunakan metode
sessions.*. Untuk integrasi UI, berlangganan peristiwa Gateway dan render hanya
keluarga peristiwa yang dipahami aplikasi Anda.
Kode aplikasi vs kode Plugin
Gunakan RPC Gateway saat kode berada di luar OpenClaw:
- skrip Node yang memulai atau mengamati eksekusi agen
- pekerjaan CI yang memanggil Gateway
- dasbor dan panel admin
- ekstensi IDE
- bridge eksternal yang tidak perlu menjadi Plugin kanal
- pengujian integrasi dengan transport Gateway palsu atau nyata
Gunakan SDK Plugin saat kode berjalan di dalam OpenClaw:
- Plugin penyedia
- Plugin kanal
- hook alat atau siklus hidup
- Plugin harness agen
- helper runtime tepercaya
Aplikasi eksternal sebaiknya tidak mengimpor openclaw/plugin-sdk/*; subpath tersebut ditujukan untuk
Plugin yang dimuat oleh OpenClaw.
