Local HTTP API

Expose your client to local automation tools and scripts. Authentication is verified against your signaling server, and access is off by default.

@if (!isElectron) {

The local API is only available in the packaged Electron desktop app.

} @else {

Server

Enable to start a local HTTP server. By default it only listens on the loopback interface.

Run local API server Start the HTTP server on this machine. Serve Docusaurus documentation at /docusaurus Hosts the built app and plugin documentation from local desktop resources. Allow connections from your network Bind to all interfaces (0.0.0.0). Other devices on your LAN will be able to reach the API. Only enable this on networks you trust.

Port

Change the listening port if 17878 is in use. Press save to apply.

Authentication

Bearer tokens are issued only after a username/password is verified against one of the signaling servers below. Add the full URL (including https://) of every signaling server you trust.

Documentation

Browse the API in a privacy-respecting locally hosted Scalar reference. No telemetry, no AI, no remote network calls.

Serve Scalar documentation at /docs Loads from local app resources only. The OpenAPI document is always available at /api/openapi.json.

@if (status().baseUrl) {

Listening at {{ status().baseUrl }}

}

@if (errorMessage(); as message) {

} }