Документация
AACSearch предоставляет управляемый поиск через API с проверкой доступа организации. Создавайте индексы, загружайте документы и ищите через консоль, REST API или SDK. Платформа применяет права доступа, квоты и аналитику.
AACSearch предоставляет управляемый поиск через API с проверкой доступа организации. Создавайте индексы, загружайте документы и ищите через консоль, REST API или SDK. Платформа применяет права доступа, квоты и аналитику.
Все эндпоинты в этой документации реально обслуживаются сервисом по пути /api/v1, а тела запросов и ответов соответствуют коду в packages/api/routes/v1.
С чего начать
Обзор платформы
Как связаны тенанты, поисковый движок и API.
Быстрый старт
Создать индекс, загрузить документы, выполнить первый поиск.
Справочник API
Аутентификация, эндпоинты, форматы запросов и ответов.
Ошибки и лимиты
Коды ошибок, лимиты запросов, квоты тарифов и работа кошелька.
Что умеет платформа
- Изоляция организаций. Доступ к индексу проверяется в рамках организации ключа. Фильтры организации и доступа к документам применяются на сервере.
- Публичный API на ключах. Ключи выглядят как
aac_live_…, несут набор scope-прав и хранятся в виде SHA-256-хеша: открытое значение показывается один раз. - Поиск, а не только совпадение слов. Опечатки, фасеты, группировка, фильтры, векторный и гибридный семантический поиск, автодополнение, учёт клика и конверсий.
- AI-функции на том же индексе. Ответы RAG со ссылками на источники, диалоговый ассистент со стримингом, поиск на естественном языке, голосовые и графические запросы.
- Прозрачный учёт расхода. Поиски, документы, AI-токены и переиндексации считаются за расчётный период;
GET /billing/usageиGET /billing/walletпоказывают те же цифры, которые применяет API. - Виджет, которому не нужен ключ в браузере. Ваш сервер обменивает API-ключ на короткоживущий токен сессии только для поиска (
POST /api/v1/embed/session); скрипт встраивания использует только этот токен через прокси AACSearch.
Структура документации
| Раздел | Содержание |
|---|---|
| Начало работы | Обзор платформы и быстрый старт из пяти шагов |
| Справочник API | Аутентификация, поиск, подсказки, документы, аналитика, сессия встраивания, статус, вебхуки, ошибки |
| SDK | Типизированные клиенты для TypeScript и Python |
| Руководства | Семантический поиск, RAG-ассистент, голос и изображения, эксперименты, коннекторы, биллинг, виджет |
Версии и совместимость
Версия API указана в пути (/api/v1). Ответы — JSON с ключами в snake_case; ошибки всегда приходят в конверте {"error": {"code", "message", "request_id"}}. В каждом ответе есть request_id, который стоит указывать в обращении в поддержку.
Доступные функции перечислены в GET /api/v1/capabilities. Поддерживаемой функции могут дополнительно требоваться модель, поля индекса или настройки развёртывания. Версия движка и инфраструктурные сведения относятся к администрированию платформы.