Документация по API

Документация по публичному API платформы EvoAI. Здесь описаны все доступные методы для интеграции с агентами и управления базами знаний.

Базовый URL

https://api.evo-ai.ru/v1

Все запросы отправляются на этот адрес.

Аутентификация

Для доступа к API используйте Bearer-токен. Передавайте его в заголовке Authorization каждого запроса:

Authorization: Bearer {ваш_API_ключ}

Храните API-ключ только на серверной стороне. Никогда не передавайте его в клиентский код — это может привести к несанкционированному доступу к данным.

Разделы API

Агенты

Методы для работы с агентами: отправка и получение сообщений, управление диалогами, сбор обратной связи.

Метод

Описание

Отправка сообщения

Отправить сообщение и получить ответ агента

Остановка генерации

Прервать генерацию ответа

История сообщений

Получить историю сообщений в диалоге

Список диалогов

Получить список всех диалогов пользователя

Рекомендуемые вопросы

Получить рекомендуемые вопросы к ответу

Отправка отзыва

Оценить ответ агента

Список отзывов

Получить все отзывы по агенту

Загрузка файла

Загрузить файл для отправки его агенту

Базы знаний

Методы для управления базами знаний: создание, настройка, загрузка документов.

Метод

Описание

Создание базы знаний

Создать пустую базу знаний

Список баз знаний

Получить список всех баз знаний

Информация о базе знаний

Получить детальную информацию о базе знаний

Обновление базы знаний

Обновить настройки базы знаний

Удаление базы знаний

Удалить базу знаний

Создание документа

Загрузить документ в базу знаний

Удаление документа

Удалить документ из базы знаний

Формат данных

  • Все запросы и ответы используют формат JSON

  • Кодировка — UTF-8

  • Временные метки передаются как Unix timestamp (целое число, секунды)

  • Идентификаторы объектов — строки в формате UUID v4

Полная спецификация OpenAPI: