На этой странице
- Справочник REST API
- Ключи API
- Граф агентов
- Аналитика
- Аутентификация
- Карта фрагментов
- Фрагменты
- Словарь
- Документы
- Модели эмбеддингов
- Наборы для оценки
- Оценка качества
- Извлечение
- Граф знаний
- Группы
- Установка
- Доступ к инсталляции
- MCP
- Участники
- Служебные сведения
- Схема метаданных
- Пайплайн
- Поиск и ответы
- Рубрики
- Первичная настройка
- Настройки пространства
- Пространства
- Векторные хранилища
Справочник REST API¶
Скачайте снимок OpenAPI
с идентификаторами операций, схемами, пагинацией и требованиями
к авторизации. Таблицы ниже используют тот же снимок, что и
сгенерированные клиенты.
У работающей установки запросите GET /api/v1/meta, чтобы узнать
версию выпуска и API. Схемы этой версии доступны по
/docs/openapi.json/ и /docs/openapi.yaml/, просмотр — в
/docs/scalar/, /docs/swagger/, /docs/redoc/ и
/docs/stoplight/. Сохраняйте завершающие косые черты в путях.
Пагинация. Передавайте
pageиpage_size, если операция их принимает. Элементы лежат вpage.object_list, число страниц — вnum_pages.Ошибки. Используйте
reasonв логике клиента, если поле есть. Вnamesмогут быть значения, вdetail— сообщения.Фоновые операции.
202означает приём операции. Проверяйте завершение через эндпоинт статуса.Сервисы. Используйте ключ с нужной областью доступа. См. первый запрос REST.
Сессии браузера. Вход и обновление требуют настроенный origin веб-интерфейса. Отправьте почту и пароль на
POST /api/v1/auth/token, чтобы получить токен доступа. Браузер передаёт HTTP-only cookie наPOST /api/v1/auth/token/refresh. Выход —POST /api/v1/auth/logout.MCP. Передавайте токен OAuth в эндпоинт MCP. См. Подключите клиент MCP.
Ключи API¶
Метод и путь |
Операция |
Коды ответа |
|---|---|---|
|
|
|
|
|
|
|
|
|
Граф агентов¶
Метод и путь |
Операция |
Коды ответа |
|---|---|---|
|
|
|
|
|
|
|
|
|
Аналитика¶
Метод и путь |
Операция |
Коды ответа |
|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Аутентификация¶
Метод и путь |
Операция |
Коды ответа |
|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Карта фрагментов¶
Метод и путь |
Операция |
Коды ответа |
|---|---|---|
|
|
|
|
|
|
|
|
|
Фрагменты¶
Метод и путь |
Операция |
Коды ответа |
|---|---|---|
|
|
|
|
|
|
|
|
|
Словарь¶
Метод и путь |
Операция |
Коды ответа |
|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Документы¶
Метод и путь |
Операция |
Коды ответа |
|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Модели эмбеддингов¶
Метод и путь |
Операция |
Коды ответа |
|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Наборы для оценки¶
Метод и путь |
Операция |
Коды ответа |
|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Оценка качества¶
Метод и путь |
Операция |
Коды ответа |
|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Извлечение¶
Метод и путь |
Операция |
Коды ответа |
|---|---|---|
|
|
|
Граф знаний¶
Метод и путь |
Операция |
Коды ответа |
|---|---|---|
|
|
|
|
|
|
Группы¶
Метод и путь |
Операция |
Коды ответа |
|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Установка¶
Метод и путь |
Операция |
Коды ответа |
|---|---|---|
|
|
|
Доступ к инсталляции¶
Метод и путь |
Операция |
Коды ответа |
|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
MCP¶
Метод и путь |
Операция |
Коды ответа |
|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Участники¶
Метод и путь |
Операция |
Коды ответа |
|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Служебные сведения¶
Метод и путь |
Операция |
Коды ответа |
|---|---|---|
|
|
|
Схема метаданных¶
Метод и путь |
Операция |
Коды ответа |
|---|---|---|
|
|
|
Пайплайн¶
Метод и путь |
Операция |
Коды ответа |
|---|---|---|
|
|
|
|
|
|
|
|
|
Поиск и ответы¶
Метод и путь |
Операция |
Коды ответа |
|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
Рубрики¶
Метод и путь |
Операция |
Коды ответа |
|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Первичная настройка¶
Метод и путь |
Операция |
Коды ответа |
|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Настройки пространства¶
Метод и путь |
Операция |
Коды ответа |
|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Пространства¶
Метод и путь |
Операция |
Коды ответа |
|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Векторные хранилища¶
Метод и путь |
Операция |
Коды ответа |
|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|