Обзор Helpfy AI API
Helpfy AI API позволяет подключить бота к своему приложению: отправлять сообщения, получать ответы, вести диалоги и управлять базой знаний.
Адрес API
https://app.helpfy.ai/api/v1
Для собственной установки используйте адрес своего сервера. API приложения размещен на https://app.helpfy.ai/api/v1.
Авторизация
Передавайте HTTP Basic с парой email:api_key. API-ключ можно получить в настройках аккаунта Helpfy AI. Авторизация и заголовки.
curl --request GET "https://app.helpfy.ai/api/v1/bots" \
--user "user@example.com:api_key" \
--header 'Accept: application/json'
Основные задачи
| Задача | Метод |
|---|---|
| Посмотреть ботов | Получить список ботов |
| Создать бота | Создать бота |
| Отправить сообщение | Синхронный ответ или асинхронный запрос |
| Проверить результат | Получить статус запроса |
| Сохранить контекст переписки | Создать диалог |
| Добавить знания | Создать группу, документ или загрузить PDF |
| Настроить поведение | Создать модель поведения |
| Добавить готовый ответ | Первая линия |
| Подключить внешнее действие | Функции |
| Настроить цепочку диалога | Сценарии |
| Посмотреть запросы и ошибки | Журнал |
| Объяснить термин | Создать термин |
Разделы обучения бота
Обзор всех шести разделов: модель поведения, словарь, функции, сценарии, первая линия и база знаний.
Примеры интеграции
- Первый бот и запрос.
- Запросы, статусы и контекст.
- Работа с базой знаний.
- Вебхуки результатов.
- Ошибки и ограничения.
Каждый метод описан на отдельной странице: URL, таблицы параметров, пример запроса и раскрывающиеся примеры ответов. Значения в примерах условные; используйте идентификаторы, возвращённые вашей установкой.
Доступ к объектам ограничен правами вашей учётной записи.