Brix developer docs
Control Brix digital signage from code or an AI agent. REST API, MCP server, webhooks, API keys and a full reference generated from the OpenAPI spec.
View as Markdown · For AI agents: the full docs index is at /llms.txt
Brix is cloud digital signage software. Everything the Brix CMS does goes through the same public API, so a script, an integration or an AI agent can do it too: list screens, upload media, build playlists, schedule content, take over screens for a set time, and read proof of play and uptime.
Four ways in
| Way in | Use it when | Start here |
|---|---|---|
| REST API | You write code: a sync job, a POS or HR integration, a report. | Quickstart |
| MCP server | You want Claude, ChatGPT, Cursor or another agent to operate your screens. | Connect an AI agent (MCP) |
| TypeScript SDK | You write TypeScript or JavaScript and want typed calls. Node, Deno, Bun, browsers and Workers. | TypeScript SDK |
| CLI | You work in a terminal or a shell script: reboot a screen, upload media, cast content. | Command-line tool (CLI) |
Both the REST API and the MCP server use the same API keys, the same permissions and the same workspace boundary. The SDK and the CLI call the REST API, so they use them too. claude.ai and ChatGPT can also connect to the MCP server by signing in, with no key.
Brix is in Claude’s connector directory: claude.ai/directory/connectors/brix. What it does and what to ask: Brix connector for Claude. Setup details: Connect an AI agent (MCP).
The basics
- Base URL:
https://api.brixsignage.com. Every path starts with/v1. - Auth:
Authorization: Bearer <api key>. Create keys in the CMS at Settings > AI, API & MCP. See Authentication and scopes. - Success bodies are
{ "data": ... }. Errors are{ "error": "<code>", "message": "<text>" }. See Errors and rate limits. - Default rate limit: 600 requests per minute per workspace, across all keys.
- Every workspace can create API keys. There is no separate API plan and no per-call charge.
- MCP endpoint:
https://api.brixsignage.com/v1/mcp.
curl https://api.brixsignage.com/v1/me \
-H "Authorization: Bearer $BRIX_API_KEY"
Pages
- Quickstart: create a key, make a first call, list screens, cast content to a screen.
- Authentication and scopes: key format, permissions, location-pinned keys, OAuth client credentials.
- Errors and rate limits: the error envelope, error codes, rate-limit headers, retries, idempotency.
- Pagination: cursor pagination on list endpoints.
- Connect an AI agent (MCP): Claude Code, Claude Desktop, Cursor, ChatGPT and the Claude API, plus the full tool catalog.
- Webhooks: subscribe to events, verify signatures, retries.
- API reference: every customer endpoint, grouped by resource.
For agents and LLMs
- /llms.txt: a short index of Brix, with links to these pages.
- /llms-full.txt: every developer page and the full API reference as one markdown file.
- Every page here has a markdown twin. Add
.mdto the path without the trailing slash, for example /developers/quickstart.md. - OpenAPI 3.1 spec: https://api.brixsignage.com/v1/openapi.json. A copy is also served at https://brixsignage.com/openapi.json.