The API uses HTTP GET requests in other to start, pause or advance a rundown. These can be used with tools like Bitfocus’ Companion - where you can use buttons on a Stream Deck to take control of your rundown and other pieces of equipment during a video production.
The API also requires an API token as a security step to ensure only you - or your team mates - have control of any given rundown.
Get the API token
API tokens can be generated from within the Rundown Studio dashboard.
Only team admins can generate and regenerate these tokens, however anyone on your team can read and use the token.
Generating the token can be done in the API section of the dashboard.
Copy this API token to your clipboard as we will need it a little later.
An example URL for interacting with our API is as follows…
The socket.io endpoint receives real-time push messages from the server whenever there is a timing-related change in the rundown. Note that the socket.io endpoint does not listen for any incoming messages.
Enter your API credentials and try it here:
# Click connect ...
The server will send the following events:
serverTime – The server time sent on a 30s interval, used to sync clocks
Note: The timesnap event contains timestamps in milliseconds since UNIX epoch. The duration is derived from deadline - kickoff = duration. The remaining time can be calculated by deadline - now = remaining.