These example prompts can be used with AI coding assistants (Claude, ChatGPT, Copilot, Cursor, etc.) to quickly build integration apps against the Brivo Access API. Click "Copy" on any prompt block below and paste it into your assistant.
Before You Start
- Obtain API credentials from your Brivo account (client ID, client secret, API key).
- Point your AI assistant at https://apidocs.brivo.com/llms.txt. It is the entry point to all Brivo API documentation — the AI follows it to find every reference file it needs.
Example Prompts
Full-Featured Management App
A React + TypeScript + Vite app demonstrating auth, user/site/door management,
and emergency scenarios. Requires VITE_CLIENT_ID, VITE_CLIENT_SECRET, and
VITE_API_KEY in .env.
Build a React + TypeScript + Tailwind CSS app (Vite) with a login page that authenticates with the Brivo API using the password grant. Include user management (Brivo Users only, not Administrators), add/remove BMP credentials (use the digital invitation flow for BMP credential creation; credential management lives within the user detail view, not a separate page), site management (read-only: list and detail view), initiate and clear default emergency scenarios, and door management (list and unlock only). Provide a dashboard with clickable widgets that navigate to each feature. Read https://apidocs.brivo.com/llms.txt for API documentation. Use only llms.txt and the files it references. VITE_CLIENT_ID, VITE_CLIENT_SECRET, and VITE_API_KEY are in .env. Use a Vite dev-server proxy for CORS: /auth → https://auth.brivo.com, /api → https://api.brivo.com Display API errors in the UI with the HTTP status and response body.
User Provisioning Script
Bulk-provision users from a CSV. Requires BRIVO_CLIENT_ID,
BRIVO_CLIENT_SECRET, BRIVO_API_KEY, BRIVO_USERNAME, and BRIVO_PASSWORD
in .env.
Expected CSV columns: firstName, lastName, email, credentialFormat,
credentialReferenceId, facilityCode, cardNumber, groupName.
Write a Node.js script that reads users from a CSV file and provisions them in Brivo Access. For each row, create the user, create and assign a credential, and assign group membership. Read https://apidocs.brivo.com/llms.txt for API documentation. Use only llms.txt and the files it references. BRIVO_CLIENT_ID, BRIVO_CLIENT_SECRET, BRIVO_API_KEY, BRIVO_USERNAME, and BRIVO_PASSWORD are in .env. CSV columns: firstName, lastName, email, credentialFormat (default "Standard 26 Bit"), credentialReferenceId, facilityCode, cardNumber, groupName. Generate a sample CSV with a few rows using "Visitors" as the default groupName. Cache lookup data (credential formats, group name-to-ID mappings) before processing rows. Use case-insensitive matching for name-based lookups. Validate every row against the cached data and report all mismatches before processing any rows. On any API error, stop and log the HTTP status, response body, the failing row, and the operation that failed.
Access Event Dashboard
A React + TypeScript + Vite app that displays access events with filtering by
site, access point, and date range. Requires VITE_CLIENT_ID,
VITE_CLIENT_SECRET, and VITE_API_KEY in .env.
Build a React + TypeScript + Tailwind CSS app (Vite) with a login page that authenticates with the Brivo API using the password grant. Display access events with filtering by site, access point, and date range. Read https://apidocs.brivo.com/llms.txt for API documentation. Use only llms.txt and the files it references. VITE_CLIENT_ID, VITE_CLIENT_SECRET, and VITE_API_KEY are in .env. Display API errors in the UI with the HTTP status and response body.
Tips for Better Results
- Always reference llms.txt — Include the full URL
(
https://apidocs.brivo.com/llms.txt) so the AI follows the documented navigation chain to endpoint details, auth flows, and schemas. - Specify your stack — Include the framework, language, and bundler so the AI scaffolds the project correctly.
- Mention the .env pattern — Indicate where credentials live and what
prefix to use (e.g.,
VITE_for Vite apps). - Start focused, then expand — Begin with a single feature (e.g., "list users") and iterate. AI assistants produce better code in incremental steps.