Skip to content

Server

alphabase serve starts the AlphaBase runtime as an HTTP API.

Terminal window
alphabase serve --hostname 127.0.0.1 --port 4096

Core Endpoints

  • /runtime/health
  • /runtime/capabilities

For local development, the running server’s OpenAPI document is available at:

http://127.0.0.1:4096/doc

The document is disabled on non-loopback listeners by default because it includes administrative and experimental route metadata. Keep it local and authenticated; do not publish or index the resulting schema. Administrative deployment controls belong in the deployment’s private operator documentation.

Client Usage

Use official AlphaBase clients (Desktop, VS Code, CLI/TUI, SDK) for normal operation. The running build’s OpenAPI document may list administrative or experimental routes. Listing a route does not make it a supported public API.

Runtime Clients

The same server contract is used by:

  • TUI
  • Desktop app
  • VS Code extension
  • SDK clients

Security

For remote access, use strong authentication, verified TLS, and network controls. See Network.