Documentation Index
Fetch the complete documentation index at: https://api-docs.rhombus.community/llms.txt
Use this file to discover all available pages before exploring further.
Developer tools and integrations
New features
Rhombus CLI — A command-line tool for managing your entire Rhombus deployment from the terminal. Supports 60+ API resource categories, video stitching, frame analysis, real-time alert monitoring, and AI-powered chat. Available via Homebrew, shell script, or from source. Read the guideReact SDK — The official@rhombussystems/react package provides drop-in components for embedding Rhombus camera streams in your React applications. Includes both a DASH buffered player and a realtime H.264 WebSocket player. Read the guideRhombus API MCP Server — An MCP server that gives AI tools like Claude, Cursor, and others direct access to your cameras, access control, sensors, and the full Rhombus platform. Supports 30+ tools across all major resource types. Read the guideClaude Code Plugins — Ready-made skills, agents, and hooks for Claude Code organized by persona (developer, user, partner). Install from the Rhombus Claude Code Plugin Marketplace. Read the guideEdgeCaster RTSP Gateway — A Raspberry Pi edge gateway that converts Rhombus secure camera streams to RTSP for legacy VMS, NVR, and third-party video systems. Read the guideOfficial n8n community node — The @rhombussystems/n8n-nodes-client package provides native Rhombus access in n8n with 6 resource types and 19 operations — no raw HTTP configuration needed. Read the guideOAuth 2.0 authentication — You can now authenticate Rhombus users in your application using OAuth 2.0 with PKCE (“Sign in with Rhombus”). Read the guideSAML SSO and SCIM provisioning — Programmatically configure SAML single sign-on and SCIM user provisioning for your Rhombus organization, with support for Okta, Azure AD, Google Workspace, and OneLogin. Read the guideUpdates
API Reference navigation — The API Reference sidebar now organizes 800+ endpoints into 7 collapsible groups (Cameras & Video, Access Control, Security & Alerts, IoT Sensors, Organization & Users, Integrations, Devices & System) for faster browsing.Rate limits guide — New documentation covering how Rhombus API rate limiting works, including retry strategies and code examples. Read the guideWebSocket documentation — Comprehensive rewrite of the real-time event streaming guides covering authentication, connection lifecycle, STOMP protocol, event monitoring, and troubleshooting. Read the guidesImproved implementation guides — The alarm monitoring and IoT sensors guides now include complete API workflows with multi-language code examples.Updated: 2026-04-20
Major API Expansion
The Rhombus API has been updated with 29 new endpoints added across 2 new service categories.New Endpoints
Relay (24 endpoints):- NVR management: details, state, uptime, reboot, unregister, firmware updates
- Third-party camera integration: assign, authenticate, discover, manage passwords, RTSP endpoints
- PTZ controls: move and status
- Boulevard integration: create, read, update, delete, and connection testing
New Service Categories
- Relay Webservice
API Version: 1.0 Updated: 2026-04-02
New API Endpoints
The Rhombus API has been updated with 2 new endpoints added.New Endpoints
Component:POST /api/component/findPaginatedComponentEventsByAccessControlledDoor- Retrieve all component events relevant to the specified AccessControlledDoor
POST /api/report/getOccupancyCountsV2- Get occupancy counts V2
API Version: 1.0 Updated: 2026-03-07
New API Endpoints
The Rhombus API has been updated with 2 new endpoints added.New Endpoints
Report:POST /api/report/getBatchThresholdCrossingCountReport- Get batch threshold crossing count reportPOST /api/report/getThresholdCrossingCountReportForOrg- Get org wide batch threshold crossing count report
API Version: 1.0 Updated: 2026-02-10
New API Endpoints
The Rhombus API has been updated with 5 new endpoints added.New Endpoints
Elevator:POST /api/component/elevator/addAccessControlledElevatorLandingLabel- Create a label that can be assigned to an access controlled elevator landingPOST /api/component/elevator/findAccessControlledElevatorLandingShadows- Find access controlled elevator landing shadows within the orgPOST /api/component/elevator/findAccessControlledElevatorLandingShadowsByLocation- Find access controlled elevator landing shadows within the specified locationPOST /api/component/elevator/getAccessControlledElevatorLandingLabelsForOrg- Get all access controlled elevator landing labels for the organizationPOST /api/component/elevator/removeAccessControlledElevatorLandingLabel- Remove a label to an access controlled elevator landing
API Version: 1.0 Updated: 2026-01-30
Documentation Navigation Restructure
Reorganized the documentation into topic-based navigation groups for easier discovery.- Guides: Getting started, implementation guides for cameras, access control, alarm monitoring, IoT sensors, and more
- Integrations: Low-code/no-code platforms (Zapier, Make.com, N8N) and AI tool integration via MCP
- API Reference: Complete REST API reference with live endpoint testing, auto-generated from the OpenAPI spec
New Documentation Launch
Complete redesign of the Rhombus Developer Documentation, now powered by Mintlify.- New platform: Migrated to Mintlify with improved search, dark mode, and mobile support
- 3-tab navigation: Guides, Integrations, and API Reference for clear content separation
- Interactive API playground: Live endpoint testing directly in the documentation
- Nightly sync: Automated pipeline keeps API documentation current with production
- AI-ready: MCP server integration,
llms.txtcontext files, and downloadable OpenAPI spec