RPC and API
การผสานรวม Gateway สำหรับแอปภายนอก
แอปภายนอกควรสื่อสารกับ OpenClaw ผ่านโปรโตคอล Gateway ในตอนนี้ ใช้ Gateway WebSocket และเมธอด RPC เมื่อสคริปต์ แดชบอร์ด งาน CI ส่วนขยาย IDE หรือกระบวนการอื่นต้องการเริ่มการรันเอเจนต์ สตรีมเหตุการณ์ รอ ผลลัพธ์ ยกเลิกงาน หรือตรวจสอบทรัพยากร Gateway
สิ่งที่พร้อมใช้งานในตอนนี้
| พื้นผิว | สถานะ | ใช้สำหรับ |
|---|---|---|
| โปรโตคอล Gateway | พร้อม | การขนส่ง WebSocket, connect handshake, ขอบเขตการยืนยันตัวตน, การกำหนดเวอร์ชันโปรโตคอล และเหตุการณ์ |
| ข้อมูลอ้างอิง Gateway RPC | พร้อม | เมธอด Gateway ปัจจุบันสำหรับเอเจนต์ เซสชัน งาน โมเดล เครื่องมือ artifact และการอนุมัติ |
openclaw agent |
พร้อม | การผสานสคริปต์แบบครั้งเดียวเมื่อการเรียกผ่านเชลล์ไปยัง CLI เพียงพอ |
openclaw message |
พร้อม | การส่งข้อความหรือการกระทำของช่องทางจากสคริปต์ |
แผนผังซอร์สมีงานแพ็กเกจภายในสำหรับไลบรารีไคลเอนต์ในอนาคต แต่ นั่นไม่ใช่พื้นผิวการติดตั้งสาธารณะ ให้ถือว่าเป็นรายละเอียดการใช้งานตัวอย่าง จนกว่าแพ็กเกจจะถูกเผยแพร่และกำหนดเวอร์ชันแล้ว
เส้นทางที่แนะนำ
- รันหรือค้นหา Gateway
- เชื่อมต่อผ่านโปรโตคอล Gateway
- เรียกเมธอด RPC ที่จัดทำเอกสารไว้จากข้อมูลอ้างอิง Gateway RPC
- ตรึงเวอร์ชัน OpenClaw ที่คุณใช้ทดสอบ
- ตรวจสอบข้อมูลอ้างอิง RPC อีกครั้งเมื่ออัปเกรด OpenClaw
สำหรับการรันเอเจนต์ ให้เริ่มด้วย RPC agent และจับคู่กับ agent.wait เมื่อ
คุณต้องการผลลัพธ์สุดท้าย สำหรับสถานะการสนทนาที่คงทน ให้ใช้เมธอด sessions.*
สำหรับการผสาน UI ให้สมัครรับเหตุการณ์ Gateway และเรนเดอร์เฉพาะ
กลุ่มเหตุการณ์ที่แอปของคุณเข้าใจ
โค้ดแอปเทียบกับโค้ด Plugin
ใช้ Gateway RPC เมื่อโค้ดอยู่นอก OpenClaw:
- สคริปต์ Node ที่เริ่มหรือสังเกตการรันเอเจนต์
- งาน CI ที่เรียก Gateway
- แดชบอร์ดและแผงผู้ดูแลระบบ
- ส่วนขยาย IDE
- บริดจ์ภายนอกที่ไม่จำเป็นต้องกลายเป็น Plugin ช่องทาง
- การทดสอบการผสานกับการขนส่ง Gateway จำลองหรือจริง
ใช้ Plugin SDK เมื่อโค้ดรันภายใน OpenClaw:
- Plugin ผู้ให้บริการ
- Plugin ช่องทาง
- ฮุกเครื่องมือหรือวงจรชีวิต
- Plugin ฮาร์เนสเอเจนต์
- ตัวช่วยรันไทม์ที่เชื่อถือได้
แอปภายนอกไม่ควรนำเข้า openclaw/plugin-sdk/*; เส้นทางย่อยเหล่านั้นมีไว้สำหรับ
Plugin ที่ OpenClaw โหลด
