RPC and API
Integrazioni Gateway per app esterne
Le app esterne dovrebbero comunicare con OpenClaw tramite il protocollo Gateway oggi. Usa Gateway WebSocket e i metodi RPC quando uno script, una dashboard, un job CI, un'estensione IDE o un altro processo vuole avviare esecuzioni di agenti, trasmettere eventi in streaming, attendere i risultati, annullare il lavoro o ispezionare le risorse Gateway.
Cosa è disponibile oggi
| Superficie | Stato | Usala per |
|---|---|---|
| Protocollo Gateway | Pronto | Trasporto WebSocket, handshake di connessione, ambiti auth, versionamento del protocollo ed eventi. |
| Riferimento RPC Gateway | Pronto | Metodi Gateway correnti per agenti, sessioni, attività, modelli, strumenti, artefatti e approvazioni. |
openclaw agent |
Pronto | Integrazione con script una tantum quando invocare la CLI è sufficiente. |
openclaw message |
Pronto | Invio di messaggi o azioni di canale da script. |
L'albero sorgente contiene lavoro su pacchetti interni per una futura libreria client, ma questa non è una superficie di installazione pubblica. Considerala un dettaglio di implementazione in anteprima finché i pacchetti non saranno pubblicati e versionati.
Percorso consigliato
- Esegui o individua un Gateway.
- Connettiti tramite il protocollo Gateway.
- Chiama i metodi RPC documentati dal riferimento RPC Gateway.
- Blocca la versione di OpenClaw rispetto alla quale esegui i test.
- Ricontrolla il riferimento RPC quando aggiorni OpenClaw.
Per le esecuzioni di agenti, inizia con l'RPC agent e abbinalo a agent.wait quando
ti serve un risultato terminale. Per uno stato di conversazione duraturo, usa i metodi sessions.*.
Per le integrazioni UI, sottoscrivi gli eventi Gateway e renderizza solo le
famiglie di eventi che la tua app comprende.
Codice app rispetto a codice Plugin
Usa Gateway RPC quando il codice vive fuori da OpenClaw:
- script Node che avviano o osservano esecuzioni di agenti
- job CI che chiamano un Gateway
- dashboard e pannelli di amministrazione
- estensioni IDE
- bridge esterni che non devono diventare Plugin di canale
- test di integrazione con trasporti Gateway finti o reali
Usa il Plugin SDK quando il codice viene eseguito dentro OpenClaw:
- Plugin provider
- Plugin di canale
- hook di strumento o del ciclo di vita
- Plugin di harness agente
- helper runtime attendibili
Le app esterne non dovrebbero importare openclaw/plugin-sdk/*; quei sottopercorsi sono per
Plugin caricati da OpenClaw.
