RPC and API
Gateway-Integrationen für externe Apps
Externe Apps sollten heute über das Gateway-Protokoll mit OpenClaw kommunizieren. Verwenden Sie Gateway WebSocket und RPC-Methoden, wenn ein Skript, Dashboard, CI-Job, eine IDE- Erweiterung oder ein anderer Prozess Agent-Läufe starten, Ereignisse streamen, auf Ergebnisse warten, Arbeit abbrechen oder Gateway-Ressourcen prüfen möchte.
Was heute verfügbar ist
| Oberfläche | Status | Verwenden Sie sie für |
|---|---|---|
| Gateway-Protokoll | Bereit | WebSocket-Transport, Connect-Handshake, Auth-Bereiche, Protokollversionierung und Ereignisse. |
| Gateway-RPC-Referenz | Bereit | Aktuelle Gateway-Methoden für Agents, Sitzungen, Aufgaben, Modelle, Tools, Artefakte und Genehmigungen. |
openclaw agent |
Bereit | Einmalige Skriptintegration, wenn der Aufruf über die CLI ausreicht. |
openclaw message |
Bereit | Senden von Nachrichten oder Channel-Aktionen aus Skripten. |
Der Quellbaum enthält interne Paketarbeit für eine zukünftige Clientbibliothek, aber das ist keine öffentliche Installationsoberfläche. Behandeln Sie sie als Vorschau- Implementierungsdetail, bis die Pakete veröffentlicht und versioniert sind.
Empfohlener Weg
- Führen Sie ein Gateway aus oder ermitteln Sie eines.
- Stellen Sie eine Verbindung über das Gateway-Protokoll her.
- Rufen Sie dokumentierte RPC-Methoden aus der Gateway-RPC-Referenz auf.
- Pinnen Sie die OpenClaw-Version, gegen die Sie testen.
- Prüfen Sie die RPC-Referenz erneut, wenn Sie OpenClaw aktualisieren.
Für Agent-Läufe beginnen Sie mit dem agent-RPC und kombinieren ihn mit agent.wait, wenn
Sie ein terminales Ergebnis benötigen. Für dauerhaften Konversationszustand verwenden Sie die
sessions.*-Methoden. Für UI-Integrationen abonnieren Sie Gateway-Ereignisse und rendern nur die
Ereignisfamilien, die Ihre App versteht.
App-Code vs. Plugin-Code
Verwenden Sie Gateway-RPC, wenn Code außerhalb von OpenClaw lebt:
- Node-Skripte, die Agent-Läufe starten oder beobachten
- CI-Jobs, die ein Gateway aufrufen
- Dashboards und Admin-Panels
- IDE-Erweiterungen
- externe Bridges, die nicht zu Channel-Plugins werden müssen
- Integrationstests mit gefälschten oder echten Gateway-Transporten
Verwenden Sie das Plugin SDK, wenn Code innerhalb von OpenClaw ausgeführt wird:
- Provider-Plugins
- Channel-Plugins
- Tool- oder Lifecycle-Hooks
- Agent-Harness-Plugins
- vertrauenswürdige Runtime-Hilfsfunktionen
Externe Apps sollten openclaw/plugin-sdk/* nicht importieren; diese Unterpfade sind für
Plugins, die von OpenClaw geladen werden.
