Skip to main content
Aplicativos externos se comunicam com o OpenClaw por meio do protocolo do Gateway: transporte WebSocket e métodos RPC. Use-o quando um script, painel, trabalho de CI, extensão de IDE ou outro processo precisar iniciar execuções de agentes, transmitir eventos, aguardar resultados, cancelar trabalhos ou inspecionar recursos do Gateway.
Ainda não há um pacote cliente público no npm. Não adicione nomes de pacotes cliente do OpenClaw como dependências de aplicativos até que as notas de versão anunciem um pacote publicado e esta página inclua instruções de instalação.
Esta página se destina a código externo ao processo do OpenClaw. O código de Plugin executado dentro do OpenClaw deve usar os subcaminhos documentados de openclaw/plugin-sdk/*.

​
O que está disponível atualmente

Um futuro pacote de biblioteca cliente está em desenvolvimento interno, mas ainda não é uma interface pública de instalação. Trate-o como detalhe de implementação em prévia até que uma versão anuncie um pacote publicado e versionado.

​
Caminho recomendado

  1. Execute ou descubra um Gateway.
  2. Conecte-se por meio do protocolo do Gateway.
  3. Chame os métodos RPC documentados na referência RPC do Gateway.
  4. Fixe a versão do OpenClaw usada nos testes.
  5. Consulte 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 para obter um resultado terminal. Para manter o estado persistente da conversa, use os métodos sessions.*. Para integrações de interface, assine os eventos do Gateway e renderize somente as famílias de eventos que seu aplicativo compreende.

​
Suspensão cooperativa do host

Controladores de hospedagem que congelam ou capturam um instantâneo de um processo em execução podem usar o handshake de suspensão independente do host:
  1. Pare de aceitar tráfego externo de entrada controlado pelo host.
  2. Chame gateway.suspend.prepare com um requestId estável e exclusivo.
  3. Se a resposta for busy, mantenha o processo em execução e tente novamente mais tarde.
  4. Se for ready, salve o suspensionId retornado e congele ou capture um instantâneo do processo antes de expiresAtMs.
  5. Após o descongelamento, ou se a suspensão for abandonada, chame gateway.suspend.resume com esse suspensionId pelo WebSocket existente ou pelo caminho de controle HTTP administrativo.
Um Gateway preparado rejeita novos handshakes WebSocket. Um controlador WebSocket deve manter sua conexão autenticada aberta durante toda a operação do host. Se isso não puder ser garantido, habilite e use o Plugin RPC HTTP administrativo antes da preparação. Se o caminho de controle for perdido, aguarde o término da concessão de dois minutos antes de se reconectar; a expiração reabre a admissão automaticamente. O contrato RPC é:
  • gateway.suspend.prepare — operator.admin; parâmetros { "requestId": "stable-host-operation-id" }
  • gateway.suspend.status — operator.read; parâmetros { "suspensionId": "id-from-prepare" }
  • gateway.suspend.resume — operator.admin; parâmetros { "suspensionId": "id-from-prepare" }
Os IDs têm os espaços nas extremidades removidos, devem conter um caractere que não seja espaço em branco e são limitados a 128 caracteres. Um resultado de preparação ocupado tem status: "busy", reason, retryAfterMs, activeCount e blockers. Um resultado pronto tem este formato:
O status retorna {"status":"running"} ou um resultado pronto com expiresAtMs. A retomada retorna {"ok":true,"status":"running","resumed":true}; repeti-la após uma retomada bem-sucedida retorna resumed: false. Um ID de solicitação concorrente ou uma falha transitória na retomada do agendador retorna o erro repetível UNAVAILABLE com retryAfterMs. Durante a recuperação do agendador, as operações de preparação, status e retomada retornam esse erro, o Gateway permanece não pronto e bloqueado por segurança, e o host não deve congelá-lo nem capturar um instantâneo. O OpenClaw tenta recuperar o agendador automaticamente e só reabre a admissão após a recuperação ser bem-sucedida. Um ID de retomada incompatível retorna INVALID_REQUEST. A preparação compartilha o orçamento de gravações do plano de controle do Gateway de três tentativas por minuto; respeite o atraso retornado para nova tentativa. Os clientes WebSocket são agrupados por dispositivo e IP. Os controladores HTTP administrativos são agrupados pelo IP resolvido do cliente, portanto, controladores atrás de um mesmo proxy podem compartilhar um orçamento. A preparação apenas recusa novas operações: o OpenClaw fecha a admissão de novas raízes, sessões e comandos, pausa as execuções automáticas do cron e inspeciona o trabalho de forma síncrona. Se houver algo ativo, ele retoma o agendador e reabre a admissão antes de retornar busy; ele não interrompe nem drena esse trabalho. Uma concessão pronta dura dois minutos. Repetir prepare com o mesmo requestId a renova; a expiração retoma o agendador antes de reabrir a admissão. Uma emissão de reinicialização cujo prazo ocorra durante uma concessão pronta aguarda até que a concessão seja retomada; uma reinicialização em andamento faz a preparação retornar busy. Enquanto estiver pronto, /healthz permanece ativo e /readyz retorna 503. Respostas de prontidão locais ou autenticadas incluem gateway-draining; sondagens remotas não autenticadas recebem apenas { "ready": false }. A sonda de integridade HTTP, os métodos de suspensão em conexões WebSocket existentes e uma rota RPC HTTP administrativa já habilitada permanecem disponíveis. Outros RPCs retornam o erro repetível UNAVAILABLE. Rotas HTTP internas de trabalho do usuário e rotas HTTP comuns de plugins, incluindo APIs compatíveis com a OpenAI, operações de ferramentas e sessões, monitoramentos de nós e hooks configurados, retornam 503 com error.code: "gateway_unavailable". Novos upgrades de WebSocket pertencentes a plugins também retornam 503; isso abrange a responsabilidade pelo upgrade, não o trabalho realizado posteriormente por um socket de Plugin estabelecido. Esse handshake não persiste mensagens recebidas, não interrompe transportes de canais de terceiros nem controla a plataforma de hospedagem. O host deve bloquear seu tráfego de entrada antes da preparação e continua responsável por despertar, capturar instantâneo/congelar e interromper. activeCount é a contagem agregada de trabalhos rastreados, enquanto blockers contém as contagens de categorias diferentes de zero e detalhes limitados das tarefas. Isso não é uma barreira geral de quiescência do processo. Um bloqueador background-exec é apenas agregado: texto de comandos, IDs de processos, saída e identificadores de sessão ou escopo nunca atravessam o protocolo. A integridade dos canais, manutenção, atualização de cache, sessões WebSocket de plugins estabelecidas e trabalhos em segundo plano não registrados pertencentes a plugins podem permanecer ativos. A plataforma de hospedagem deve congelar ou capturar um instantâneo de toda a árvore de processos e de seu sistema de arquivos de forma consistente; este primeiro contrato não pode comprovar que trabalhos não registrados estejam ociosos.
Para o agendamento de despertar do host, mantenha a parte voltada ao OpenClaw em um Plugin dentro do processo e projete instantâneos completos idempotentes para o adaptador externo do host. O controlador de hospedagem não deve importar o SDK de Plugin nem reconstruir o estado do cron a partir de deltas de eventos. Consulte Projeção externa segura do cron .

​
Código de aplicativo versus código de Plugin

Use RPC do Gateway quando o código estiver fora do OpenClaw:
  • scripts Node que iniciam ou observam execuções de agentes
  • trabalhos de CI que chamam um Gateway
  • painéis e consoles administrativos
  • extensões de IDE
  • pontes externas que não precisam se tornar plugins de canal
  • testes de integração com transportes de Gateway simulados ou reais
Use o SDK de Plugin quando o código for executado dentro do OpenClaw:
  • plugins de provedor
  • plugins de canal
  • hooks de ferramenta ou ciclo de vida
  • plugins de infraestrutura de agentes
  • auxiliares confiáveis de tempo de execução
Aplicativos externos não devem importar openclaw/plugin-sdk/*; esses subcaminhos se destinam a plugins carregados pelo OpenClaw.

​
Relacionados