RPC and API
Integrações do Gateway para apps externos
Aplicativos externos devem falar com o OpenClaw pelo protocolo Gateway hoje. Use métodos WebSocket e RPC do Gateway quando um script, painel, job de CI, extensão de IDE ou outro processo quiser iniciar execuções de agentes, transmitir eventos, aguardar resultados, cancelar trabalho ou inspecionar recursos do Gateway.
O que está disponível hoje
| Superfície | Status | Use para |
|---|---|---|
| Protocolo Gateway | Pronto | Transporte WebSocket, handshake de conexão, escopos de autenticação, versionamento de protocolo e eventos. |
| Referência RPC do Gateway | Pronto | Métodos atuais do Gateway para agentes, sessões, tarefas, modelos, ferramentas, artefatos e aprovações. |
openclaw agent |
Pronto | Integração de script de execução única quando chamar a CLI via shell é suficiente. |
openclaw message |
Pronto | Enviar mensagens ou ações de canal a partir de scripts. |
A árvore de código-fonte contém trabalho de pacote interno para uma futura biblioteca cliente, mas isso não é uma superfície de instalação pública. Trate-o como detalhe de implementação em prévia até que os pacotes sejam publicados e versionados.
Caminho recomendado
- Execute ou descubra um Gateway.
- Conecte-se pelo protocolo Gateway.
- Chame métodos RPC documentados da referência RPC do Gateway.
- Fixe a versão do OpenClaw contra a qual você testa.
- Verifique novamente a referência RPC ao atualizar o OpenClaw.
Para execuções de agentes, comece com o RPC agent e combine-o com agent.wait quando
você precisar de um resultado terminal. Para estado de conversa durável, use os métodos
sessions.*. Para integrações de UI, assine eventos do Gateway e renderize apenas as
famílias de eventos que seu app entende.
Código de app versus código de Plugin
Use RPC do Gateway quando o código vive fora do OpenClaw:
- scripts Node que iniciam ou observam execuções de agentes
- jobs de CI que chamam um Gateway
- dashboards e painéis administrativos
- extensões de IDE
- bridges externos que não precisam se tornar plugins de canal
- testes de integração com transportes Gateway falsos ou reais
Use o SDK de Plugin quando o código roda dentro do OpenClaw:
- plugins de provedor
- plugins de canal
- hooks de ferramenta ou ciclo de vida
- plugins de harness de agente
- auxiliares de runtime confiáveis
Aplicativos externos não devem importar openclaw/plugin-sdk/*; esses subcaminhos são para
plugins carregados pelo OpenClaw.
