This endpoint sends a remote control command to the live show. You can target a show by its ID, or let the endpoint work out the live show from the venue, the room or the show type. It needs a show control key, which can only reach this endpoint and the current show endpoint.
Endpoint
POST /api/v1/<production>/shows/control.
GET works too, for clients that can only send GET requests.
Query parameters
| Parameter | Required | Description |
|---|---|---|
action |
Yes |
The command to send. One of next, prev, or
toggle-break.
|
show_id |
No | The show to control. Without it, the endpoint finds the live show from the parameters below. |
venue_id |
No | Only consider shows at this venue. |
room_id |
No | Only consider shows in this room. Needs venue_id as well. |
show_type |
No | Only consider shows of this type. |
Example request
curl -X POST "https://confirmed.show/api/v1/<production>/shows/control?action=next" \
-H "Authorization: Bearer <token>"Success response
200 OK
{
"status": "ok",
"command_id": "a1b2c3d4-5678-90ab-cdef-1234567890ab"
}
The command_id is unique to each command, so you can use it to keep track
of the commands you've sent.
Errors
| Status | Body | Cause |
|---|---|---|
404 |
{ "error": "No current show found" } |
No live show matched the lookup parameters. |
422 |
{ "error": "room_id can only be used together with
venue_id" }
|
room_id was passed without venue_id. |
422 |
{ "error": [ ... ] } |
The action value is missing or not one of the accepted values.
|