Beam Docs

Everything needed to understand Beam end to end.

These docs cover the Beam desktop app, browser viewer flow, relay deployment model, and session API so the public site reflects the actual product instead of a recycled marketing template.

Open Quickstart Read API Reference

Desktop host app Browser viewer Relay + signaling Control-plane API

Quickstart

Understand how the operator app works today: sharing codes, recent sessions, relay mode, and connection flow.

Open Quickstart

Deployment

Review the production service model, required inbound ports, environment variables, and browser-facing components.

Open Deployment

API Reference

See the session lifecycle endpoints used to create joins, fetch session state, accept sessions, and end them.

Open API

Beam architecture at a glance

Desktop surface

The current Windows app exposes a Home screen, Recent sessions, and Settings. Operators can start hosting, copy a generated address, and enter a remote connection ID.

Network surface

Beam runs a signaling service, UDP relay, control-plane API, and WebRTC signaling server. This lets sessions work from ordinary networks without requiring both peers to port-forward.

Embedded surface

The control-plane API exists so another product can create session records, distribute join tokens, and manage lifecycle state programmatically.