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