API Reference
Обзор API
Стабильные HTTP API платформы и правила выбора нужной группы эндпоинтов.
botruntime предоставляет четыре публичных HTTP API. Все запросы идут на
https://botruntime.ru и используют JSON, если операция не работает с байтами
файла.
| API | Для чего нужен |
|---|---|
| Chat API | Диалоги, сообщения, пользователи, события и состояние бота. |
| Admin API | Боты, воркспейсы, участники и интеграции. |
| Files API | Файлы, поиск, теги и passages для базы знаний. |
| Tables API | Таблицы и операции со строками. |
Страницы операций генерируются из OpenAPI. В справочник входят только стабильные
операции с меткой documented. Экспериментальные и внутренние маршруты здесь не
публикуются.
Базовый запрос
curl https://botruntime.ru/v1/chat/conversations \
-H "Authorization: Bearer $BOT_TOKEN" \
-H "x-bot-id: $BOT_ID"Конкретная операция показывает обязательные заголовки, параметры, тело и ответы. Общие правила описаны на страницах «Аутентификация» и «Пагинация и ошибки».
OpenAPI
Машиночитаемый контракт доступен по адресу
/docs/openapi.json. Используйте его
для генерации клиентов, проверки запросов и импорта в API-инструменты.