# Rhombus Developer Documentation

> Developer documentation for the Rhombus API — cameras, access control, sensors, and security platform integrations.

- [API Reference (959 pages)](https://api-docs.rhombus.community/_llms/en/api-reference.md): Documentation for API Reference.

## Guides

### Getting Started

- [Introduction](https://api-docs.rhombus.community/index.md): Get started with the Rhombus developer platform — build security integrations using the REST API for cameras, access control, sensors, alarms, and analytics.
- [Developer Resources and Tools](https://api-docs.rhombus.community/resources.md): Developer tools, downloads, OpenAPI specs, Postman collections, SDKs, and community resources to help you build faster with the Rhombus API.
- [Rhombus CLI](https://api-docs.rhombus.community/rhombus-cli.md): Manage cameras, doors, alerts, sensors, and your entire Rhombus deployment from the command line — stitch video, monitor alerts, and chat with AI tooling.
- [Sign in with Rhombus](https://api-docs.rhombus.community/oauth-authentication.md): Add Sign in with Rhombus to your application using OAuth 2.0 with PKCE — handle authorization codes, access tokens, refresh tokens, and SSO identity claims.
- [Partner API Calls](https://api-docs.rhombus.community/partner-api-calls.md): Make Rhombus API calls as a partner — authenticate with a partner API key, manage your client organizations with partner endpoints, and scope client-level calls to a managed org using the x-auth-org header.
- [API Regions (US & EU)](https://api-docs.rhombus.community/api-regions.md): Connect to the right Rhombus API region — US and EU endpoint URLs, region-bound API keys, CLI region configuration, and cross-region troubleshooting.
- [Rate Limits](https://api-docs.rhombus.community/rate-limits.md): Understand Rhombus API rate limits and build resilient integrations that handle 429 throttled responses with exponential backoff and retry logic.
- [Changelog](https://api-docs.rhombus.community/changelog.md): Release notes for the Rhombus API — track new endpoints, breaking changes, deprecations, SDK updates, and platform improvements over time.

### Implementation Guides

#### Cameras

- [Stream Live and Recorded Video from Cameras](https://api-docs.rhombus.community/implementations/streaming-video.md): Embed live and recorded video from Rhombus cameras in your applications using HLS streams, thumbnails, and shared playback URLs delivered through the API.
- [Video Player Integration](https://api-docs.rhombus.community/implementations/video-player.md): Build a custom web video player for Rhombus camera streams with HLS live playback, recorded video VOD, scrubbing, and timeline controls using the API.
- [React SDK](https://api-docs.rhombus.community/implementations/react-sdk.md): Embed Rhombus camera streams in React applications with the official SDK, featuring DASH buffered playback and real-time H.264 WebSocket players via WebCodecs.
- [LAN Realtime Detection Overlay](https://api-docs.rhombus.community/implementations/lan-realtime-detection-overlay.md): Parse AI bounding boxes embedded in the LAN H.264 WebSocket stream and render them on top of live video using the Rhombus React SDK or your own client.
- [Multi-Camera Video Synchronization with ISOBMFF](https://api-docs.rhombus.community/implementations/advanced-implementation.md): Extract Rhombus millisecond timestamps embedded in ISOBMFF video containers to align frames precisely across multiple cameras for forensic analysis.
- [Retrieving Audio from A100 Audio Gateway](https://api-docs.rhombus.community/implementations/retrieving-audio.md): Download recorded audio from a Rhombus A100 Audio Gateway using the API — fetch DASH MPD manifests, retrieve segments, and play back audio over WAN VOD.
- [EdgeCaster RTSP Gateway](https://api-docs.rhombus.community/implementations/edgecaster-rtsp.md): Run EdgeCaster on a Raspberry Pi 5 or any Ubuntu/Debian machine to re-broadcast Rhombus camera streams as sub-second-latency RTSP for legacy VMS, NVR, and third-party video systems.

#### Access Control

- [Access Control](https://api-docs.rhombus.community/implementations/access-control.md): Manage Rhombus access control through the API — list access-controlled doors, remotely unlock, issue and assign credentials, build access groups and grants, and activate lockdown plans.
- [QR Code Access Control](https://api-docs.rhombus.community/implementations/qr-code-access-control.md): Implement QR code door unlock with Rhombus access control — generate visitor credentials, validate codes, and trigger touchless door entry via the API.

#### Alarm Monitoring

- [Alarm Monitoring](https://api-docs.rhombus.community/implementations/alarm-monitoring.md): Build alarm monitoring integrations with the Rhombus API — track locations, dispatch responders, and manage threat cases and security alerts in real time.

#### IoT Sensors

- [IoT Sensors](https://api-docs.rhombus.community/implementations/iot-sensors.md): Read climate data from Rhombus IoT sensors via the API to monitor temperature, humidity, air quality, and environmental conditions across your facilities.

#### Storage & Backup

- [Backup Footage to Local Storage](https://api-docs.rhombus.community/implementations/backup-footage-local-storage.md): Download and archive Rhombus camera footage to local storage like NAS or external drives using the API for compliance, retention, and offline access.

#### Identity & Access

- [SAML SSO & SCIM Provisioning](https://api-docs.rhombus.community/implementations/saml-sso-provisioning.md): Configure SAML single sign-on and SCIM user provisioning for Rhombus via the API — integrate Okta, Azure AD, Google Workspace, OneLogin, and other IdPs.

#### Analytics & AI

- [License Plate Recognition & Vehicles](https://api-docs.rhombus.community/implementations/lpr-vehicle.md): Query license plate detection events, search plates with fuzzy matching, build a watchlist of saved vehicles, run per-device reports, and export vehicle data as CSV with the Rhombus API.
- [Face Recognition & People Counting](https://api-docs.rhombus.community/implementations/faces-people-counting.md): Enroll and manage known people, query face-match events, tune the matching threshold, and pull camera people-counting analytics through the Rhombus API.
- [Reports & Analytics](https://api-docs.rhombus.community/implementations/reports-analytics.md): Pull count and time-series analytics from the Rhombus API — people and vehicle counts, occupancy trends, line-crossing (threshold) counts, and CSV export.

### Real-time Events

#### Webhooks

- [Rhombus Webhooks](https://api-docs.rhombus.community/webhooks.md): Configure Rhombus webhooks to receive real-time HTTP POST notifications for camera alerts, door events, sensor thresholds, and button presses without polling.
- [Webhook Listeners](https://api-docs.rhombus.community/implementations/webhook-listener.md): Receive Rhombus webhooks on private servers behind firewalls using reverse SSH tunnels, ngrok, or a reverse proxy — no public IP or port forwarding required.

#### WebSocket

- [WebSocket Overview](https://api-docs.rhombus.community/websocket/overview.md): Stream real-time security events from Rhombus over WebSocket and STOMP — receive policy alerts, device updates, and activity instantly without polling the API.
- [WebSocket Authentication](https://api-docs.rhombus.community/websocket/authentication.md): Authenticate Rhombus WebSocket connections using API tokens — construct connection URLs, send STOMP CONNECT frames, and handle partner API integrations.
- [WebSocket Event Monitoring and Filtering](https://api-docs.rhombus.community/websocket/event-monitoring.md): Subscribe to real-time WebSocket events from Rhombus — filter and process policy alerts, device state changes, motion detection, and access control events.
- [WebSocket Connection Lifecycle](https://api-docs.rhombus.community/websocket/connection-lifecycle.md): Manage the full lifecycle of a Rhombus WebSocket connection — perform STOMP handshakes, send heartbeats, handle reconnections, and close gracefully.
- [STOMP Protocol Reference](https://api-docs.rhombus.community/websocket/stomp-protocol.md): Reference for the STOMP 1.2 messaging protocol used by Rhombus WebSocket — frame structure, headers, CONNECT, SUBSCRIBE, MESSAGE, and ERROR command details.
- [WebSocket Code Examples in Python, JavaScript, Go](https://api-docs.rhombus.community/websocket/code-examples.md): Production-ready Python, JavaScript, and Go code examples for connecting to Rhombus WebSocket — handle STOMP, authentication, heartbeats, and reconnection.
- [WebSocket Troubleshooting](https://api-docs.rhombus.community/websocket/troubleshooting.md): Diagnose and resolve common Rhombus WebSocket issues — connection failures, STOMP errors, missed heartbeats, authentication problems, and dropped events.

## Integrations

### Low Code / No Code

- [Integrate with Zapier](https://api-docs.rhombus.community/low-code-no-code/zapier.md): Connect Rhombus to thousands of apps with the native Zapier integration — build event-driven automations for camera alerts, doors, and sensors without code.
- [Integrate with Make.com](https://api-docs.rhombus.community/low-code-no-code/make.md): Automate Rhombus security workflows with Make.com's visual no-code platform — connect cameras, doors, and sensors to thousands of apps without writing code.
- [Integrate with n8n](https://api-docs.rhombus.community/low-code-no-code/n8n.md): Automate Rhombus security workflows in self-hosted n8n with the official community node — orchestrate cameras, access control, IoT sensors, and AI agents.

### AI & LLMs

- [Documentation MCP](https://api-docs.rhombus.community/documentation-mcp.md): Connect Claude, Cursor, VS Code, and other AI tools directly to Rhombus API documentation using the Model Context Protocol (MCP) server.
- [Rhombus API MCP Server](https://api-docs.rhombus.community/rhombus-mcp.md): Give Claude and other AI assistants direct access to your Rhombus cameras, doors, sensors, and alerts through the Model Context Protocol (MCP) Node.js server.
- [Claude Code Plugins](https://api-docs.rhombus.community/claude-code-plugins.md): Install Rhombus skills, sub-agents, and hooks for Claude Code to build integrations, manage devices, and monitor alerts from your terminal.

## Other

- [AGENTS](https://api-docs.rhombus.community/AGENTS.md)
- [CLAUDE](https://api-docs.rhombus.community/CLAUDE.md)
- [2026 03 18 api docs restructure](https://api-docs.rhombus.community/docs/superpowers/plans/2026-03-18-api-docs-restructure.md)
- [2026 04 09 autonomous api docs](https://api-docs.rhombus.community/docs/superpowers/plans/2026-04-09-autonomous-api-docs.md)
- [2026 04 09 docs quality overhaul](https://api-docs.rhombus.community/docs/superpowers/plans/2026-04-09-docs-quality-overhaul.md)
- [2026 04 09 autonomous api docs design](https://api-docs.rhombus.community/docs/superpowers/specs/2026-04-09-autonomous-api-docs-design.md)
- [Developer guide rate limits and webhooks](https://api-docs.rhombus.community/scripts/developer-guide-rate-limits-and-webhooks.md)
- [VERSIONING](https://api-docs.rhombus.community/VERSIONING.md)

## OpenAPI Specs

- [public](https://api2.rhombussystems.com/api/openapi/public.json)

## AsyncAPI Specs

- [rhombus_asyncapi](/rhombus_asyncapi.json)

> The links below point to documentation indexes. Follow each `/_llms/` index recursively until you reach documentation pages.

## Indexes

- [English / API Reference (959 pages)](https://api-docs.rhombus.community/_llms/en/api-reference.md): Documentation for English / API Reference.
- [English / API Reference / Access Control Webservice (65 pages)](https://api-docs.rhombus.community/_llms/en/api-reference/access-control-webservice.md): Documentation for English / API Reference / Access Control Webservice.
- [English / API Reference / Camera Webservice (61 pages)](https://api-docs.rhombus.community/_llms/en/api-reference/camera-webservice.md): Documentation for English / API Reference / Camera Webservice.
- [English / API Reference / Component Webservice (62 pages)](https://api-docs.rhombus.community/_llms/en/api-reference/component-webservice.md): Documentation for English / API Reference / Component Webservice.
- [English / API Reference / Event Webservice (42 pages)](https://api-docs.rhombus.community/_llms/en/api-reference/event-webservice.md): Documentation for English / API Reference / Event Webservice.
- [English / API Reference / Access Control Integrations Webservice (101 pages)](https://api-docs.rhombus.community/_llms/en/api-reference/access-control-integrations-webservice.md): Documentation for English / API Reference / Access Control Integrations Webservice.
- [English / API Reference / Incident Management Integrations Webservice (34 pages)](https://api-docs.rhombus.community/_llms/en/api-reference/incident-management-integrations-webservice.md): Documentation for English / API Reference / Incident Management Integrations Webservice.
- [English / API Reference / Org Webservice (48 pages)](https://api-docs.rhombus.community/_llms/en/api-reference/org-webservice.md): Documentation for English / API Reference / Org Webservice.
- [English / API Reference / Policy Webservice (54 pages)](https://api-docs.rhombus.community/_llms/en/api-reference/policy-webservice.md): Documentation for English / API Reference / Policy Webservice.
- [English / API Reference / Report Webservice (26 pages)](https://api-docs.rhombus.community/_llms/en/api-reference/report-webservice.md): Documentation for English / API Reference / Report Webservice.
- [Spanish (39 pages)](https://api-docs.rhombus.community/_llms/es.md): Documentation for Spanish.