Zum Hauptinhalt springen
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.
Es gibt noch kein öffentliches npm-Clientpaket. Fügen Sie keine OpenClaw-Clientpaket- Namen als Anwendungsabhängigkeiten hinzu, bis Release Notes ein veröffentlichtes Paket ankündigen und diese Seite Installationsanweisungen enthält.
Diese Seite ist für Code außerhalb des OpenClaw-Prozesses gedacht. Plugin-Code, der innerhalb von OpenClaw ausgeführt wird, sollte stattdessen die dokumentierten openclaw/plugin-sdk/*-Unterpfade verwenden.

​
Was heute verfügbar ist

OberflächeStatusVerwenden Sie sie für
Gateway-ProtokollBereitWebSocket-Transport, Connect-Handshake, Auth-Bereiche, Protokollversionierung und Ereignisse.
Gateway-RPC-ReferenzBereitAktuelle Gateway-Methoden für Agents, Sitzungen, Aufgaben, Modelle, Tools, Artefakte und Genehmigungen.
openclaw agentBereitEinmalige Skriptintegration, wenn der Aufruf über die CLI ausreicht.
openclaw messageBereitSenden 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

  1. Führen Sie ein Gateway aus oder ermitteln Sie eines.
  2. Stellen Sie eine Verbindung über das Gateway-Protokoll her.
  3. Rufen Sie dokumentierte RPC-Methoden aus der Gateway-RPC-Referenz auf.
  4. Pinnen Sie die OpenClaw-Version, gegen die Sie testen.
  5. 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.

​
Verwandt