The API

The API lets your own tools read and run your rooms.

Every plan

What it does

Everything an operator does from the controller, a tool can do through the API: start, stop, and cue timers, add or take away time, show a message, black out the screens, and change the rundown. It also reads what a room shows right now, and can follow every change as it happens.

People use it for:

• A Stream Deck button that starts the next timer or adds a minute, with no app open on the computer (see a button link).
• Show control: Companion’s generic HTTP actions, or any show-control system that can send a web request, cue a timer as part of a cue list (see Companion).
• A script that builds the day’s rundown from a spreadsheet, or renames rooms before an event.
• Your own screens and dashboards: a lobby sign, a stage manager’s overview of every room, or a graphics system that shows the time left on a livestream.

Keys

A tool reaches the API with an API key. An admin of the account makes keys in the app, and each key says what it may reach and do:

• Reach: every room of the account, rooms made later included, or one room.
• What it may do: read the rooms; read and run the show (playback, blackout, messages); or read, run, and edit (timers, messages, and the room’s settings).

The API answers JSON at https://app.cuestride.com/api/v1. How many keys an account holds depends on its plan: 1 on Starter, 10 on Pro, 25 on Premium, and unlimited on Enterprise. A revoked or expired key frees its place.

Start here

1. Make an API key in Account settings, with pictures of each step.
2. Send your first requests: find your room, read it, and run it, with what each answers and what the screen shows after it. A Stream Deck button is the last step.
3. Set it up in your tools: Companion, a Stream Deck, vMix, QLab, OBS, Zapier, Make, n8n, Apple Shortcuts, and Home Assistant, and what to avoid in each.
4. Look up the rest in the API reference: every route, the limits, the refusals, and the stream of changes.