API / MCP overview
Thin reference for operators and integrators. Prefer live paths you can open on the box over inventing catalogs. There is no full public OpenAPI page on this site — use live /api/v1/… routes and the MCP URL from AI → MCP.
Same show graph
BPShowServer exposes the same show graph the browser UI uses:
| Surface | Role |
|---|---|
| UI | Browser console (always on) |
| OSC | Desks and tools |
| HTTP | Simple cue / status requests under /api/v1/… |
| MCP | Assistants and agents — configure under AI → MCP |
| CLI | Scripts and headless boxes |
Automation bridges should call the same sinks and tiles operators see (Automation).
Network sinks API (known)
| Item | Value |
|---|---|
| Path | GET /api/v1/audio/sinks |
| Role | List network audio sinks (AES67 / ST2110 / Sonos / garden speaker / console·Q-SYS as available) |
| UI counterpart | I/O → Devices / Integrations endpoints |
| Spatial bind | Control → Audio → Spatial Layouts → Add Speaker → Audio Output → Select output… |
| Docs story | Differentiator vs Local Pulse (demo-box only) |
| Guided | Getting Started · 04 · Overview |
This page does not publish a full OpenAPI surface. Use the live sinks route and in-product MCP URL.
Related (UnrealRTC, not cartwall): authenticated GET /api/v1/webrtc/sources appears in UnrealRTC quickstarts for source IDs.
MCP — on-prem first (Community 1.0.190)
On-prem MCP is the preferred assistant path on this site:
- Bring ShowServer up; confirm UI on http://localhost:7474.
- Open AI → MCP (
/mcp). Page title: MCP Server. - Configure:
- Enable MCP server
- MCP URL
- Transport
- Require bearer token
- Access token
- Tool policy: No tools / Code Mode / Full catalog / Custom
- Point a local MCP client at the MCP URL shown on that page.
- Prefer tools that fire existing Action Deck / Automation cues over inventing parallel cue lists (AI · Getting Started · 06).
Cloud MCP
Already operate a Cloud-capable ShowServer? Point Cloud MCP at that deployment’s MCP endpoint (same field family as on-prem MCP Server). Prefer on-prem MCP for Community Free from Download. Details: UnrealRTC · Remote / Cloud studio.
Cloud MCP is not required for Voice LLM, Plugin Builder, or cartwall SFX — those run on the LAN show graph.
Related
- I/O — Devices / Integrations + Add Endpoint
- AI — five AI stories + MCP Server / Plugin Builder chrome
- Troubleshooting — first-timer stubs
- System — host health (sinks bind via I/O / Spatial Layouts, not a System sink editor)
- Getting Started — Default-first install