RPC and API
Интеграции Gateway для внешних приложений
Внешние приложения сегодня должны взаимодействовать с OpenClaw через протокол Gateway. Используйте Gateway WebSocket и методы RPC, когда скрипту, панели мониторинга, заданию CI, расширению IDE или другому процессу нужно запускать выполнения агентов, передавать поток событий, ждать результатов, отменять работу или проверять ресурсы Gateway.
Что доступно сегодня
| Поверхность | Статус | Для чего использовать |
|---|---|---|
| протокол Gateway | Готово | Транспорт WebSocket, рукопожатие подключения, области авторизации, версионирование протокола и события. |
| справочник Gateway RPC | Готово | Текущие методы Gateway для агентов, сеансов, задач, моделей, инструментов, артефактов и подтверждений. |
openclaw agent |
Готово | Одноразовая интеграция со скриптами, когда достаточно запуска через CLI. |
openclaw message |
Готово | Отправка сообщений или действий каналов из скриптов. |
Дерево исходного кода содержит внутреннюю работу над пакетами для будущей клиентской библиотеки, но это не публичная поверхность установки. Считайте это предварительной деталью реализации, пока пакеты не будут опубликованы и версионированы.
Рекомендуемый путь
- Запустите или обнаружьте Gateway.
- Подключитесь через протокол Gateway.
- Вызывайте документированные методы RPC из справочника Gateway RPC.
- Зафиксируйте версию OpenClaw, с которой вы тестируете.
- Повторно проверяйте справочник RPC при обновлении OpenClaw.
Для выполнений агентов начните с RPC agent и используйте его вместе с agent.wait, когда
вам нужен конечный результат. Для долговечного состояния беседы используйте методы sessions.*.
Для интеграций с UI подпишитесь на события Gateway и отображайте только те
семейства событий, которые понимает ваше приложение.
Код приложения и код Plugin
Используйте Gateway RPC, когда код находится вне OpenClaw:
- скрипты Node, которые запускают выполнения агентов или наблюдают за ними
- задания CI, которые вызывают Gateway
- панели мониторинга и административные панели
- расширения IDE
- внешние мосты, которым не нужно становиться Plugin каналов
- интеграционные тесты с поддельными или реальными транспортами Gateway
Используйте Plugin SDK, когда код выполняется внутри OpenClaw:
- Plugin провайдеров
- Plugin каналов
- хуки инструментов или жизненного цикла
- Plugin обвязки агента
- доверенные вспомогательные средства среды выполнения
Внешние приложения не должны импортировать openclaw/plugin-sdk/*; эти подпути предназначены для
Plugin, загружаемых OpenClaw.
