Skip to content

Web API

The WebUI uses internal HTTP and SSE endpoints. They are part of the local dashboard contract and require authentication unless explicitly used during first-run setup or login.

Authentication and profile

Endpoint groupPurpose
/api/auth/meCurrent authenticated user
/api/dashboard/logoutLogout
/api/profileProfile data and preferences
/api/profile/passwordChange password
/api/profile/logout-other-sessionsRevoke other sessions

Dashboard and runtime

Endpoint groupPurpose
/api/bootstrapInitial WebUI bootstrap data
/api/healthConnector health
/api/snapshotDashboard snapshot
/api/active-sessionsActive local and peer sessions
/api/tasksQueue and task data
/api/progressRuntime progress stream/data
/api/metricsCurrent metrics
/api/metrics/historyMetrics history
/api/jobsUnified jobs
/api/traceTrace timeline

Sessions and prompts

Endpoint groupPurpose
/api/sessionsSession listing and details
/api/promptSubmit prompts
/api/uploadUpload attachments
/api/abortAbort active work
/api/stopStop active work
/api/retryRetry prompt/message
/api/syncSync selected session state
/api/chat-historyWebUI chat history
/api/mirrorMirror settings

Administration

Endpoint groupPurpose
/api/usersUser management
/api/groupsGroup management
/api/channelsRegistered chat channels and rooms
/api/auditAudit events
/api/locksUser lock state
/api/settingsRuntime settings
/api/doctorDoctor checks
/api/diagnosticsDiagnostics and support bundles

Operations

Endpoint groupPurpose
/api/versionNordRelay and agent versions
/api/updateNordRelay update
/api/agent-updatesAgent update jobs
/api/adapters/healthAdapter health
/api/adapters/conformanceAdapter conformance
/api/logsLogs
/api/artifactsArtifact listing and actions
/api/workflowsWorkflow and template management
/api/peersPeer management and proxying

Use the generated route and type files in src/web/ when integrating with the internal WebUI contract.

Released under the MIT License.