Загрузка...

Блог

REST API Adminica: query, chat и stream по ключу

REST API коннектор Adminica

Коннектор «REST API» — это серверный доступ к Adminica по ключу ak_…: запросы к библиотеке, чат и стриминг без браузера. Удобно для бэкендов, CI, внутренних ботов и автоматизаций.

Как получить ключ

  1. Профиль → Безопасность → API-ключи → создать ключ.
  2. Скопируйте секрет сразу — повторно он не показывается.
  3. Передавайте ключ в заголовке авторизации согласно Quickstart.

Типичные вызовы

  • POST /api/v1/query — ответ с источниками по запросу.
  • Эндпоинты чата / stream — для диалоговых клиентов.
  • Сценарии research / creative review — через соответствующие API при включённых фичах.

Для IDE удобнее MCP (настройка Cursor); REST — когда нужен свой HTTP-клиент.

Практики применения

  • Сервис поддержки дергает query и показывает ответ агенту.
  • Ночной job собирает дайджест и шлёт webhook.
  • Тесты качества RAG дергают API в CI.

Где REST API уместен в архитектуре

API-ключ (ak_) даёт серверный доступ к той же библиотеке и вашим документам, что и веб-чат: поиск, диалог, потоковые ответы. Типичные кейсы — CRM, внутренний портал, cron-задача «сводка по архиву», бот в мессенджере, где UI Adminica не нужен.

Эндпоинты и ожидания

ВызовКогда
queryБыстрый поиск фрагментов с метаданными
chat / streamОтвет с опорой на источники, как в чате

Храните ключ в секретах окружения, ротируйте при утечке и ограничивайте сеть (VPN, allowlist). Ответы по-прежнему должны ссылаться на записи архива — проверяйте блок источников так же, как в интерактивном чате.

Async и webhooks

Для длинных ответов используйте асинхронные паттерны из документации API: так CRM не упирается в таймаут HTTP-клиента. Webhook доставляет итог, когда RAG и модель завершили работу; в теле по-прежнему должны быть ссылки на источники — проверяйте их в интеграционных тестах так же, как в UI чата.

Итог: REST API — программный вход в ту же библиотеку и сценарии, что в веб-чате; ключ создаётся в профиле, контракт — в /docs/18-rest-api/.