RPC and API
Integracje Gateway dla aplikacji zewnętrznych
Aplikacje zewnętrzne powinny dziś komunikować się z OpenClaw przez protokół Gateway. Używaj Gateway WebSocket i metod RPC, gdy skrypt, dashboard, zadanie CI, rozszerzenie IDE lub inny proces chce uruchamiać przebiegi agentów, strumieniować zdarzenia, czekać na wyniki, anulować pracę albo sprawdzać zasoby Gateway.
Co jest dziś dostępne
| Powierzchnia | Status | Użyj do |
|---|---|---|
| Protokół Gateway | Gotowe | Transport WebSocket, uzgadnianie połączenia, zakresy autoryzacji, wersjonowanie protokołu i zdarzenia. |
| Dokumentacja RPC Gateway | Gotowe | Bieżące metody Gateway dla agentów, sesji, zadań, modeli, narzędzi, artefaktów i zatwierdzeń. |
openclaw agent |
Gotowe | Jednorazowa integracja skryptowa, gdy wystarczy wywołanie CLI z powłoki. |
openclaw message |
Gotowe | Wysyłanie wiadomości lub akcji kanału ze skryptów. |
Drzewo źródłowe zawiera wewnętrzne prace pakietowe nad przyszłą biblioteką klienta, ale nie jest to publiczna powierzchnia instalacji. Traktuj ją jako szczegół implementacji w wersji zapoznawczej, dopóki pakiety nie zostaną opublikowane i wersjonowane.
Zalecana ścieżka
- Uruchom lub wykryj Gateway.
- Połącz się przez protokół Gateway.
- Wywołuj udokumentowane metody RPC z dokumentacji RPC Gateway.
- Przypnij wersję OpenClaw, względem której testujesz.
- Przy aktualizacji OpenClaw ponownie sprawdź dokumentację RPC.
W przypadku przebiegów agentów zacznij od RPC agent i połącz go z agent.wait, gdy
potrzebujesz wyniku końcowego. Do trwałego stanu konwersacji używaj metod sessions.*.
W przypadku integracji UI subskrybuj zdarzenia Gateway i renderuj tylko te rodziny
zdarzeń, które rozumie Twoja aplikacja.
Kod aplikacji a kod Plugin
Używaj Gateway RPC, gdy kod działa poza OpenClaw:
- skrypty Node, które uruchamiają lub obserwują przebiegi agentów
- zadania CI, które wywołują Gateway
- dashboardy i panele administracyjne
- rozszerzenia IDE
- zewnętrzne mosty, które nie muszą stać się Plugin kanałów
- testy integracyjne z fałszywymi lub rzeczywistymi transportami Gateway
Używaj Plugin SDK, gdy kod działa wewnątrz OpenClaw:
- Plugin dostawców
- Plugin kanałów
- hooki narzędzi lub cyklu życia
- Plugin uprzęży agentów
- zaufane pomocniki środowiska uruchomieniowego
Aplikacje zewnętrzne nie powinny importować openclaw/plugin-sdk/*; te podścieżki są przeznaczone dla
Plugin ładowanych przez OpenClaw.
