On this page

REST API reference

Download the OpenAPI snapshot for operation IDs, schemas, pagination and authentication. The tables below use the same snapshot as the generated clients.

To inspect a running installation, use GET /api/v1/meta for its release and API version. Fetch its schema at /docs/openapi.json/ or /docs/openapi.yaml/. Browse it at /docs/scalar/, /docs/swagger/, /docs/redoc/ or /docs/stoplight/. Preserve trailing slashes as shown.

  • Pagination. Send page and page_size where supported. Read page.object_list and stop at num_pages.

  • Errors. Use reason for branching when present. names can supply values and detail has the list of messages.

  • Background work. 202 means the operation was accepted. Check its status endpoint for completion.

  • Services. Use scoped keys. See the first REST call.

  • Browser sessions. Use the configured frontend origin for login and refresh. Send email and password to POST /api/v1/auth/token for an access token. The browser sends its HTTP-only refresh cookie to POST /api/v1/auth/token/refresh. Log out with POST /api/v1/auth/logout.

  • MCP. Send the OAuth token to the MCP endpoint. See Connect an MCP client.

API Keys

Method and path

Operation

Response codes

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

Agent Graph

Method and path

Operation

Response codes

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

Analytics

Method and path

Operation

Response codes

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

Auth

Method and path

Operation

Response codes

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

Chunk Map

Method and path

Operation

Response codes

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

Chunks

Method and path

Operation

Response codes

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

Dictionary

Method and path

Operation

Response codes

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

Documents

Method and path

Operation

Response codes

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

Embedding Models

Method and path

Operation

Response codes

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

Eval Datasets

Method and path

Operation

Response codes

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

Evaluations

Method and path

Operation

Response codes

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

Extraction

Method and path

Operation

Response codes

GET /api/v1/extraction/capabilities/

getExtractionCapabilities

200, 401, 406, 502, 503

Graph

Method and path

Operation

Response codes

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

Groups

Method and path

Operation

Response codes

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

Installation

Method and path

Operation

Response codes

GET /api/v1/installation/settings

listInstallationSettings

200, 401, 406, 503

Installation access

Method and path

Operation

Response codes

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

Method and path

Operation

Response codes

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

Members

Method and path

Operation

Response codes

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

Meta

Method and path

Operation

Response codes

GET /api/v1/meta

getServerMeta

200, 406, 503

Metadata Schema

Method and path

Operation

Response codes

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

configureMetadataSchema

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

Pipeline

Method and path

Operation

Response codes

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

Retrieval

Method and path

Operation

Response codes

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

Rubrics

Method and path

Operation

Response codes

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

Setup

Method and path

Operation

Response codes

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

Space Config

Method and path

Operation

Response codes

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

Spaces

Method and path

Operation

Response codes

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

Vector Backends

Method and path

Operation

Response codes

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

Search the documentation