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

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

## Базовый URL

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

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

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

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

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

{% hint style="warning" %}
Храните API-ключ исключительно на серверной стороне. Никогда не передавайте его в клиентский код — утечка ключа может привести к несанкционированному доступу к данным.
{% endhint %}

## Разделы API

### [Приложения](https://docs.evo-ai.ru/broken-reference)

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

| Метод                                                            | Описание                                    |
| ---------------------------------------------------------------- | ------------------------------------------- |
| [Отправка сообщения](https://docs.evo-ai.ru/broken-reference)    | Отправить сообщение и получить ответ модели |
| [Остановка генерации](https://docs.evo-ai.ru/broken-reference)   | Прервать генерацию ответа                   |
| [История сообщений](https://docs.evo-ai.ru/broken-reference)     | Получить историю переписки в диалоге        |
| [Список диалогов](https://docs.evo-ai.ru/broken-reference)       | Получить список всех диалогов пользователя  |
| [Рекомендуемые вопросы](https://docs.evo-ai.ru/broken-reference) | Получить предлагаемые вопросы к ответу      |
| [Отправка отзыва](https://docs.evo-ai.ru/broken-reference)       | Оценить ответ модели                        |
| [Список отзывов](https://docs.evo-ai.ru/broken-reference)        | Получить все отзывы по приложению           |

### [База знаний](https://docs.evo-ai.ru/broken-reference)

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

| Метод                                                             | Описание                                    |
| ----------------------------------------------------------------- | ------------------------------------------- |
| [Создание базы знаний](https://docs.evo-ai.ru/broken-reference)   | Создать пустую базу знаний                  |
| [Список баз знаний](https://docs.evo-ai.ru/broken-reference)      | Получить список всех баз знаний             |
| [Получение информации](https://docs.evo-ai.ru/broken-reference)   | Получить детальную информацию о базе знаний |
| [Обновление базы знаний](https://docs.evo-ai.ru/broken-reference) | Изменить настройки базы знаний              |
| [Удаление базы знаний](https://docs.evo-ai.ru/broken-reference)   | Удалить базу знаний                         |
| [Поиск по фрагментам](https://docs.evo-ai.ru/broken-reference)    | Найти релевантные фрагменты по запросу      |

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

* Все запросы и ответы используют формат **JSON**
* Кодировка — **UTF-8**
* Временные метки передаются как **Unix timestamp** (целое число, секунды)
* Идентификаторы объектов — строки в формате **UUID v4**