Quickstart

Create your first encrypted room and invite a teammate in under two minutes.

Every Nimbus room is addressable by a short human-readable code. You can create one from the dashboard, the CLI, or a single API call.

Create a room

Request a fresh room with a POST /api/v1/rooms. The response contains the join code and a signed host token.

curl -X POST https://api.nimbusmeet.io/v1/rooms \
  -H "Authorization: Bearer $NIMBUS_TOKEN" \
  -d '{"name":"Weekly sync","e2ee":true}'

Share the returned joinUrl with anyone. No account is required to join a room as a guest.

Single sign-on

Nimbus supports SAML 2.0 and OIDC. Configure your identity provider under Admin → Authentication, then map group claims to Nimbus roles:

• owner — full workspace administration
• host — can create and moderate rooms
• member — can join rooms and start 1:1 calls

Self-hosting

The self-hosted distribution ships as a single container. Point it at a Postgres instance and a TURN server, then bring it up:

docker run -d --name nimbus \
  -e NIMBUS_DATABASE_URL=postgres://... \
  -e NIMBUS_TURN_URL=turn:turn.example.com:3478 \
  -p 443:443 ghcr.io/nimbusmeet/server:latest

Full configuration options are covered in the configuration reference.

REST API

The API is versioned and authenticated with a bearer token scoped to your workspace. Rate limits are returned in the X-RateLimit-* headers. See the full reference for endpoints covering rooms, recordings, participants and webhooks.