cosai · Документация
ВнедрениеREST API

REST API

Программный доступ к поиску, агентам и загрузке знаний.

REST API v1 — программный доступ ко всем возможностям платформы: от загрузки документов до диалога с агентом. Все примеры в этом разделе — реальные пути и форматы API.

Базовый URL: https://api.cosai.pro/v1 Аутентификация: заголовок Authorization: Bearer <api-key> (см. Аутентификация)

Основные группы методов

ГруппаМетодыНазначение
Базы знанийGET/POST /sources, POST /sources/:id/files, POST /sources/:id/documents, GET/DELETE /documents/:id, GET /jobs/:id, GET /jobs/recentСоздание баз знаний, загрузка и статус индексации документов
ПоискPOST /searchГибридный поиск по базе знаний напрямую, без диалога с агентом
АгентыGET/POST/PATCH /agents, POST /agents/:id/chat, POST/GET /agents/:id/eval, POST /agents/:id/publishСоздание и настройка агентов, диалог, проверка качества, публикация
СкиллыGET/POST /skillsКомпетенции агентов
ОнбордингPOST /onboardingМастер «отрасль + документы → работающий агент» одним запросом
УчётGET /usage, GET /modelsПотребление за 30 дней, доступный каталог моделей

Полный перечень эндпоинтов с точными схемами запросов и ответов — в автоматическом справочнике API Reference, который генерируется из спецификации API.

Формат ошибок

КодЗначение
401ключ не указан или не распознан
403домен не в allowlist виджет-ключа, либо агент не опубликован для публичной поверхности
404сущность не найдена
409eval-гейт: попытка опубликовать агента без пройденной проверки
422ошибка валидации входных данных

Дальше: Аутентификация и Примеры запросов.

On this page