RPC and API
Integraciones de Gateway para aplicaciones externas
Las aplicaciones externas deberían comunicarse con OpenClaw a través del protocolo Gateway hoy. Usa los métodos WebSocket y RPC de Gateway cuando un script, panel, trabajo de CI, extensión de IDE u otro proceso quiera iniciar ejecuciones de agentes, transmitir eventos, esperar resultados, cancelar trabajo o inspeccionar recursos de Gateway.
Qué está disponible hoy
| Superficie | Estado | Úsalo para |
|---|---|---|
| Protocolo Gateway | Listo | Transporte WebSocket, saludo de conexión, ámbitos de autenticación, versionado del protocolo y eventos. |
| Referencia RPC de Gateway | Listo | Métodos actuales de Gateway para agentes, sesiones, tareas, modelos, herramientas, artefactos y aprobaciones. |
openclaw agent |
Listo | Integración de scripts de una sola ejecución cuando invocar la CLI desde el shell es suficiente. |
openclaw message |
Listo | Enviar mensajes o acciones de canal desde scripts. |
El árbol de código fuente contiene trabajo interno de paquetes para una futura biblioteca cliente, pero esa no es una superficie de instalación pública. Trátalo como un detalle de implementación preliminar hasta que los paquetes se publiquen y tengan versiones.
Ruta recomendada
- Ejecuta o descubre un Gateway.
- Conéctate mediante el protocolo Gateway.
- Llama a métodos RPC documentados desde la referencia RPC de Gateway.
- Fija la versión de OpenClaw contra la que haces pruebas.
- Vuelve a revisar la referencia RPC al actualizar OpenClaw.
Para ejecuciones de agentes, empieza con el RPC agent y combínalo con agent.wait cuando
necesites un resultado terminal. Para estado de conversación duradero, usa los métodos sessions.*.
Para integraciones de interfaz de usuario, suscríbete a eventos de Gateway y renderiza solo las
familias de eventos que tu aplicación entienda.
Código de aplicación vs. código de Plugin
Usa RPC de Gateway cuando el código viva fuera de OpenClaw:
- scripts de Node que inician u observan ejecuciones de agentes
- trabajos de CI que llaman a un Gateway
- paneles y paneles de administración
- extensiones de IDE
- puentes externos que no necesitan convertirse en plugins de canal
- pruebas de integración con transportes de Gateway falsos o reales
Usa el SDK de Plugin cuando el código se ejecute dentro de OpenClaw:
- plugins de proveedor
- plugins de canal
- hooks de herramientas o ciclo de vida
- plugins de arnés de agente
- helpers de runtime de confianza
Las aplicaciones externas no deberían importar openclaw/plugin-sdk/*; esas subrutas son para
plugins cargados por OpenClaw.
