На этой странице

Справочник 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

Метод и путь

Операция

Коды ответа

GET /api/v1/auth/api-keys/

listApiKeys

200, 400, 401, 406, 503

POST /api/v1/auth/api-keys/

createApiKey

201, 400, 401, 403, 406, 503

DELETE /api/v1/auth/api-keys/{id}

revokeApiKey

204, 400, 401, 404, 406, 503

Граф агентов

Метод и путь

Операция

Коды ответа

GET /api/v1/agent-graph/preset

getAgentGraphPreset

200, 401, 406, 503

GET /api/v1/agent-graph/tools

getAgentToolCatalog

200, 401, 406, 503

PUT /api/v1/spaces/{space_id}/agent-graph

configureAgentGraph

200, 400, 401, 403, 404, 406, 503

Аналитика

Метод и путь

Операция

Коды ответа

DELETE /api/v1/query-log/mine

forgetMyQueries

200, 401, 406, 503

GET /api/v1/spaces/{space_id}/analytics

getSpaceAnalytics

200, 400, 401, 403, 404, 406, 503

POST /api/v1/spaces/{space_id}/analytics/datasets

collectLogDataset

201, 400, 401, 403, 404, 406, 409, 503

GET /api/v1/spaces/{space_id}/analytics/queries

listLoggedQueries

200, 400, 401, 403, 404, 406, 503

GET /api/v1/spaces/{space_id}/analytics/queries/export

exportLoggedQueries

200, 400, 401, 403, 404, 406, 503

GET /api/v1/spaces/{space_id}/analytics/queries/{query_id}

getLoggedQuery

200, 400, 401, 403, 404, 406, 503

GET /api/v1/spaces/{space_id}/analytics/settings

getAnalyticsSettings

200, 400, 401, 403, 404, 406, 503

PUT /api/v1/spaces/{space_id}/analytics/settings

updateAnalyticsSettings

200, 400, 401, 403, 404, 406, 503

GET /api/v1/spaces/{space_id}/analytics/text-accesses

listQueryTextAccesses

200, 400, 401, 403, 404, 406, 503

PUT /api/v1/spaces/{space_id}/analytics/text-readers/{user_id}

setQueryTextGrant

200, 400, 401, 403, 404, 406, 503

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

Метод и путь

Операция

Коды ответа

POST /api/v1/auth/accept-invite

acceptInvite

200, 400, 401, 403, 406, 503

POST /api/v1/auth/logout

logout

204, 401, 403, 406, 503

POST /api/v1/auth/register

register

201, 400, 406, 409, 503

POST /api/v1/auth/token

login

200, 400, 401, 403, 406, 503

POST /api/v1/auth/token/refresh

refreshToken

200, 401, 403, 406, 503

Карта фрагментов

Метод и путь

Операция

Коды ответа

GET /api/v1/spaces/{space_id}/chunk-map

getChunkMap

200, 400, 401, 404, 406, 409, 502, 503

POST /api/v1/spaces/{space_id}/chunk-map/build

buildChunkMap

202, 400, 401, 403, 404, 406, 503

POST /api/v1/spaces/{space_id}/chunk-map/give-up

giveUpChunkMapBuild

200, 400, 401, 403, 404, 406, 503

Фрагменты

Метод и путь

Операция

Коды ответа

GET /api/v1/spaces/{space_id}/chunks

listChunks

200, 400, 401, 404, 406, 503

GET /api/v1/spaces/{space_id}/chunks/sizes

getChunkSizes

200, 400, 401, 404, 406, 503

GET /api/v1/spaces/{space_id}/chunks/{chunk_id}

getChunk

200, 400, 401, 404, 406, 503

Словарь

Метод и путь

Операция

Коды ответа

GET /api/v1/spaces/{space_id}/dictionary

listDictionaryEntries

200, 400, 401, 403, 404, 406, 409, 503

POST /api/v1/spaces/{space_id}/dictionary

createDictionaryEntry

201, 400, 401, 403, 404, 406, 409, 503

GET /api/v1/spaces/{space_id}/dictionary/builds

listDictionaryBuilds

200, 400, 401, 403, 404, 406, 503

POST /api/v1/spaces/{space_id}/dictionary/builds

buildDictionary

201, 400, 401, 403, 404, 406, 503

GET /api/v1/spaces/{space_id}/dictionary/builds/{build_id}

getDictionaryBuild

200, 400, 401, 403, 404, 406, 503

POST /api/v1/spaces/{space_id}/dictionary/builds/{build_id}/retry

retryDictionaryBuild

201, 400, 401, 403, 404, 406, 503

DELETE /api/v1/spaces/{space_id}/dictionary/{entry_id}

deleteDictionaryEntry

200, 400, 401, 403, 404, 406, 409, 503

GET /api/v1/spaces/{space_id}/dictionary/{entry_id}

getDictionaryEntry

200, 400, 401, 403, 404, 406, 409, 503

PUT /api/v1/spaces/{space_id}/dictionary/{entry_id}

updateDictionaryEntry

200, 400, 401, 403, 404, 406, 409, 503

POST /api/v1/spaces/{space_id}/dictionary/{entry_id}/restore

restoreDictionaryEntry

201, 400, 401, 403, 404, 406, 409, 503

Документы

Метод и путь

Операция

Коды ответа

GET /api/v1/spaces/{space_id}/document-operations/{operation_id}

getDocumentOperation

200, 400, 401, 404, 406, 503

GET /api/v1/spaces/{space_id}/documents

listDocuments

200, 400, 401, 404, 406, 503

POST /api/v1/spaces/{space_id}/documents

ingestDocument

201, 400, 401, 403, 404, 406, 409, 413, 428, 502, 503

POST /api/v1/spaces/{space_id}/documents/archive

importArchive

202, 400, 401, 403, 404, 406, 409, 413, 502, 503

DELETE /api/v1/spaces/{space_id}/documents/{document_id}

deleteDocument

204, 400, 401, 403, 404, 406, 409, 502, 503

GET /api/v1/spaces/{space_id}/documents/{document_id}

getDocument

200, 400, 401, 404, 406, 503

PATCH /api/v1/spaces/{space_id}/documents/{document_id}

updateDocumentMetadata

200, 400, 401, 403, 404, 406, 409, 502, 503

POST /api/v1/spaces/{space_id}/documents/{document_id}/activate

activateDocument

202, 400, 401, 403, 404, 406, 409, 503

POST /api/v1/spaces/{space_id}/documents/{document_id}/deactivate

deactivateDocument

202, 400, 401, 403, 404, 406, 409, 503

GET /api/v1/spaces/{space_id}/documents/{document_id}/download

downloadDocument

200, 400, 401, 404, 406, 503

GET /api/v1/spaces/{space_id}/documents/{document_id}/original

getDocumentOriginalState

200, 400, 401, 404, 406, 503

POST /api/v1/spaces/{space_id}/documents/{document_id}/original

applyDocumentOriginal

202, 400, 401, 403, 404, 406, 409, 413, 502, 503

POST /api/v1/spaces/{space_id}/documents/{document_id}/reindex

reindexDocument

202, 400, 401, 403, 404, 406, 409, 503

Модели эмбеддингов

Метод и путь

Операция

Коды ответа

GET /api/v1/embedding-models

listEmbeddingModels

200, 401, 406, 503

POST /api/v1/embedding-models

registerEmbeddingModel

201, 400, 401, 406, 503

GET /api/v1/embedding-models/catalog

getEmbeddingModelCatalog

200, 401, 406, 503

DELETE /api/v1/embedding-models/{id}

deleteEmbeddingModel

204, 400, 401, 403, 404, 406, 409, 503

PUT /api/v1/embedding-models/{id}

reconfigureEmbeddingModel

200, 400, 401, 403, 404, 406, 409, 503

Наборы для оценки

Метод и путь

Операция

Коды ответа

GET /api/v1/eval-datasets/

listEvaluationDatasets

200, 400, 401, 406, 503

POST /api/v1/eval-datasets/

createEvaluationDataset

201, 400, 401, 406, 413, 503

GET /api/v1/eval-datasets/{dataset_id}/compare

compareEvaluationRuns

200, 400, 401, 403, 404, 406, 409, 503

DELETE /api/v1/eval-datasets/{id}

deleteEvaluationDataset

204, 400, 401, 403, 404, 406, 503

GET /api/v1/eval-datasets/{id}

getEvaluationDataset

200, 400, 401, 404, 406, 503

GET /api/v1/eval-datasets/{id}/corpus

listDatasetCorpus

200, 400, 401, 404, 406, 503

GET /api/v1/eval-datasets/{id}/queries

listDatasetQueries

200, 400, 401, 404, 406, 503

Оценка качества

Метод и путь

Операция

Коды ответа

GET /api/v1/spaces/{space_id}/evaluations

listEvaluationRuns

200, 400, 401, 403, 404, 406, 503

POST /api/v1/spaces/{space_id}/evaluations

createEvaluationRun

202, 400, 401, 403, 404, 406, 409, 503

GET /api/v1/spaces/{space_id}/evaluations/compare

compareSpaceEvaluationRuns

200, 400, 401, 403, 404, 406, 409, 503

GET /api/v1/spaces/{space_id}/evaluations/compare/queries

listComparedEvaluationQueries

200, 400, 401, 403, 404, 406, 409, 503

GET /api/v1/spaces/{space_id}/evaluations/rubric-comparison

compareEvaluationRubricAssessments

200, 400, 401, 403, 404, 406, 503

GET /api/v1/spaces/{space_id}/evaluations/{run_id}

getEvaluationRun

200, 400, 401, 403, 404, 406, 503

GET /api/v1/spaces/{space_id}/evaluations/{run_id}/assessments

listEvaluationRunAssessments

200, 400, 401, 403, 404, 406, 503

POST /api/v1/spaces/{space_id}/evaluations/{run_id}/assessments

assessEvaluationRunAnswers

202, 400, 401, 403, 404, 406, 409, 503

GET /api/v1/spaces/{space_id}/evaluations/{run_id}/queries

listEvaluationRunQueries

200, 400, 401, 403, 404, 406, 503

GET /api/v1/spaces/{space_id}/evaluations/{run_id}/rubric-assessments

listEvaluationRunRubricAssessments

200, 400, 401, 403, 404, 406, 503

POST /api/v1/spaces/{space_id}/evaluations/{run_id}/rubric-assessments

assessEvaluationRunRubric

202, 400, 401, 403, 404, 406, 409, 503

GET /api/v1/spaces/{space_id}/evaluations/{run_id}/rubric-assessments/{assessment_id}/results

listEvaluationRubricResults

200, 400, 401, 403, 404, 406, 503

Извлечение

Метод и путь

Операция

Коды ответа

GET /api/v1/extraction/capabilities/

getExtractionCapabilities

200, 401, 406, 502, 503

Граф знаний

Метод и путь

Операция

Коды ответа

POST /api/v1/spaces/{space_id}/graph/rebuild

rebuildGraph

202, 400, 401, 403, 404, 406, 409, 503

GET /api/v1/spaces/{space_id}/graph/status

getGraphStatus

200, 400, 401, 403, 404, 406, 503

Группы

Метод и путь

Операция

Коды ответа

GET /api/v1/groups/

listAccessGroups

200, 400, 401, 403, 406, 503

POST /api/v1/groups/

createAccessGroup

201, 400, 401, 403, 406, 409, 503

GET /api/v1/groups/accounts

listAccessGroupAccounts

200, 400, 401, 403, 406, 503

GET /api/v1/groups/audit

listAccessGroupAuditEvents

200, 400, 401, 403, 406, 503

GET /api/v1/groups/spaces

listAccessGroupSpaces

200, 400, 401, 403, 406, 503

DELETE /api/v1/groups/{group_id}

deleteAccessGroup

204, 400, 401, 403, 404, 406, 409, 503

PATCH /api/v1/groups/{group_id}

renameAccessGroup

200, 400, 401, 403, 404, 406, 409, 503

GET /api/v1/groups/{group_id}/members

listAccessGroupMembers

200, 400, 401, 403, 404, 406, 503

DELETE /api/v1/groups/{group_id}/members/{user_id}

removeAccessGroupMember

204, 400, 401, 403, 404, 406, 503

PUT /api/v1/groups/{group_id}/members/{user_id}

addAccessGroupMember

200, 400, 401, 403, 404, 406, 503

GET /api/v1/groups/{group_id}/spaces

listAccessGroupSpaceRoles

200, 400, 401, 403, 404, 406, 503

DELETE /api/v1/groups/{group_id}/spaces/{space_id}

removeAccessGroupSpaceRole

204, 400, 401, 403, 404, 406, 503

PUT /api/v1/groups/{group_id}/spaces/{space_id}

assignAccessGroupSpaceRole

200, 400, 401, 403, 404, 406, 503

Установка

Метод и путь

Операция

Коды ответа

GET /api/v1/installation/settings

listInstallationSettings

200, 401, 406, 503

Доступ к инсталляции

Метод и путь

Операция

Коды ответа

GET /api/v1/installation/access

getInstallationAccess

200, 401, 406, 503

DELETE /api/v1/installation/administrators/{user_id}

removeInstallationAdministrator

204, 400, 401, 403, 404, 406, 503

PUT /api/v1/installation/administrators/{user_id}

addInstallationAdministrator

204, 400, 401, 403, 404, 406, 503

GET /api/v1/installation/groups/{group_id}/create-space

getGroupCreateSpaceGrant

200, 400, 401, 403, 404, 406, 503

PUT /api/v1/installation/groups/{group_id}/create-space

setGroupCreateSpaceGrant

200, 400, 401, 403, 404, 406, 503

MCP

Метод и путь

Операция

Коды ответа

GET /api/v1/mcp/authorizations

listMcpAuthorizations

200, 400, 401, 406, 503

DELETE /api/v1/mcp/authorizations/{id}

revokeMcpAuthorization

204, 400, 401, 404, 406, 503

DELETE /api/v1/mcp/consent-requests/{ticket}

denyMcpConsentRequest

200, 400, 401, 404, 406, 409, 503

GET /api/v1/mcp/consent-requests/{ticket}

getMcpConsentRequest

200, 400, 401, 404, 406, 503

POST /api/v1/mcp/consent-requests/{ticket}

confirmMcpConsentRequest

200, 400, 401, 403, 404, 406, 409, 503

Участники

Метод и путь

Операция

Коды ответа

GET /api/v1/spaces/{space_id}/group-members

listSpaceGroupMembers

200, 400, 401, 403, 404, 406, 503

GET /api/v1/spaces/{space_id}/members

listMembers

200, 400, 401, 404, 406, 503

POST /api/v1/spaces/{space_id}/members

addMember

201, 400, 401, 403, 404, 406, 409, 503

DELETE /api/v1/spaces/{space_id}/members/{user_id}

removeMember

204, 400, 401, 403, 404, 406, 409, 503

PATCH /api/v1/spaces/{space_id}/members/{user_id}

updateMember

200, 400, 401, 403, 404, 406, 409, 503

Служебные сведения

Метод и путь

Операция

Коды ответа

GET /api/v1/meta

getServerMeta

200, 406, 503

Схема метаданных

Метод и путь

Операция

Коды ответа

PUT /api/v1/spaces/{space_id}/metadata-schema

configureMetadataSchema

202, 400, 401, 403, 404, 406, 503

Пайплайн

Метод и путь

Операция

Коды ответа

GET /api/v1/pipeline/catalog

getPipelineCatalog

200, 401, 406, 503

GET /api/v1/pipeline/comparison-catalog

getRunComparisonCatalog

200, 401, 406, 503

GET /api/v1/pipeline/presets

listPipelinePresets

200, 401, 406, 503

Поиск и ответы

Метод и путь

Операция

Коды ответа

PUT /api/v1/spaces/{space_id}/queries/{query_id}/feedback

rateQuery

204, 400, 401, 404, 406, 503

POST /api/v1/spaces/{space_id}/query

querySpace

200, 400, 401, 404, 406, 409, 502, 503

POST /api/v1/spaces/{space_id}/query/stream

querySpaceStream

200, 400, 401, 404, 406, 409, 502, 503

POST /api/v1/spaces/{space_id}/search

searchSpace

200, 400, 401, 404, 406, 409, 502, 503

Рубрики

Метод и путь

Операция

Коды ответа

GET /api/v1/rubric-versions/{id}

getRubricVersionById

200, 400, 401, 404, 406, 503

GET /api/v1/rubrics/

listRubrics

200, 400, 401, 406, 503

POST /api/v1/rubrics/

createRubric

201, 400, 401, 406, 503

GET /api/v1/rubrics/{id}

getRubric

200, 400, 401, 404, 406, 503

PATCH /api/v1/rubrics/{id}

updateRubric

200, 400, 401, 404, 406, 503

GET /api/v1/rubrics/{id}/versions

listRubricVersions

200, 400, 401, 404, 406, 503

POST /api/v1/rubrics/{id}/versions

publishRubricVersion

201, 400, 401, 404, 406, 409, 503

GET /api/v1/rubrics/{id}/versions/{version}

getRubricVersion

200, 400, 401, 404, 406, 503

GET /api/v1/spaces/{space_id}/rubric-versions/{version_id}

getSpaceRubricVersion

200, 400, 401, 404, 406, 503

Первичная настройка

Метод и путь

Операция

Коды ответа

POST /api/v1/setup/connect-llm

connectOnboardingLlm

200, 400, 401, 403, 404, 406, 409, 422, 502, 503

POST /api/v1/setup/demo

prepareOnboardingDemo

200, 400, 401, 403, 404, 406, 409, 422, 502, 503

GET /api/v1/setup/diagnostics

getOnboardingDiagnostics

200, 401, 406, 503

POST /api/v1/setup/own-space

createOnboardingSpace

200, 400, 401, 403, 404, 406, 409, 422, 502, 503

GET /api/v1/setup/progress

getOnboardingProgress

200, 401, 406, 503

PATCH /api/v1/setup/progress

updateOnboardingProgress

200, 400, 401, 406, 503

POST /api/v1/setup/space-creators

configureInitialSpaceCreators

200, 400, 401, 403, 406, 409, 503

GET /api/v1/setup/status

getSetupStatus

200, 406, 503

Настройки пространства

Метод и путь

Операция

Коды ответа

PUT /api/v1/spaces/{space_id}/config

applySpaceConfig

200, 202, 400, 401, 403, 404, 406, 409, 422, 502, 503

POST /api/v1/spaces/{space_id}/config/cancel

cancelSpaceConfigChange

200, 202, 400, 401, 403, 404, 406, 409, 503

POST /api/v1/spaces/{space_id}/config/recheck

recheckSpaceConfig

200, 400, 401, 403, 404, 406, 503

POST /api/v1/spaces/{space_id}/config/reindex

reindexSpace

202, 400, 401, 403, 404, 406, 409, 422, 503

GET /api/v1/spaces/{space_id}/config/status

getSpaceConfigStatus

200, 400, 401, 403, 404, 406, 503

POST /api/v1/spaces/{space_id}/config/validate

validateSpaceConfig

200, 400, 401, 403, 404, 406, 503

Пространства

Метод и путь

Операция

Коды ответа

GET /api/v1/spaces/

listSpaces

200, 400, 401, 406, 503

POST /api/v1/spaces/

createSpace

201, 400, 401, 403, 404, 406, 409, 422, 502, 503

POST /api/v1/spaces/validate

validateSpaceDraft

200, 400, 401, 404, 406, 502, 503

DELETE /api/v1/spaces/{id}

deleteSpace

204, 400, 401, 403, 404, 406, 409, 428, 502, 503

GET /api/v1/spaces/{id}

getSpace

200, 400, 401, 404, 406, 503

PATCH /api/v1/spaces/{id}

updateSpace

200, 400, 401, 403, 404, 406, 409, 422, 502, 503

POST /api/v1/spaces/{id}/storage/confirm

confirmSpaceStorage

200, 400, 401, 403, 404, 406, 502, 503

GET /api/v1/spaces/{id}/storage/index

getSpaceStorageIndex

200, 400, 401, 404, 406, 503

POST /api/v1/spaces/{id}/storage/index

indexSpaceStorage

202, 400, 401, 403, 404, 406, 409, 502, 503

POST /api/v1/spaces/{id}/storage/index/check

checkSpaceStorageIndex

200, 400, 401, 403, 404, 406, 409, 502, 503

POST /api/v1/spaces/{id}/storage/index/give-up

giveUpSpaceStorageIndexPass

200, 400, 401, 403, 404, 406, 503

Векторные хранилища

Метод и путь

Операция

Коды ответа

GET /api/v1/vector-backends

listVectorBackends

200, 401, 406, 503

POST /api/v1/vector-backends

registerVectorBackend

201, 400, 401, 406, 503

GET /api/v1/vector-backends/catalog

getVectorBackendCatalog

200, 401, 406, 503

DELETE /api/v1/vector-backends/{id}

deleteVectorBackend

204, 400, 401, 403, 404, 406, 409, 503

PUT /api/v1/vector-backends/{id}

reconfigureVectorBackend

200, 400, 401, 403, 404, 406, 503

ContextBase0.1.0

Поиск в документации