Controls

These endpoints do what the buttons in the Controller's status bar do: blackout, on air and flash. They can also play a chime on the outputs.

POST/rooms/{room_id}/blackout

Turn blackout on

Blacks out the Viewer.

Path parameters

Name
room_id
Type
string
Required
Description
The room's id, from its address: /o/ROOM_ID/….

Request

POST

/rooms/{room_id}/blackout

curl -X POST https://app.kloksi.com/api/v1/rooms/ROOM_ID/blackout \
  -H "Authorization: Bearer YOUR_API_KEY"

Response 200

{
  "ok": true,
  "message": "Blackout enabled",
  "data": {
    "_id": "x7kp2mqa",
    "_model": "room",
    "_updated_at": "2026-11-05T09:30:00.000Z",
    "name": "Annual Conference",
    "date": "2026-11-05",
    "blackout": false,
    "dim": 0,
    "focus_message": false,
    "on_air": false,
    "logo": "",
    "timezone": "Europe/Berlin",
    "language": "en",
    "team_id": "6f2c1e9ab04d7c3e8a5b1d20",
    "accepting_questions": false,
    "questionnaire": {
      "logo": {
        "mode": "kloksi"
      },
      "title": "",
      "subtitle": "",
      "question_label": "",
      "name_label": "",
      "hide_name": false
    },
    "protected_outputs": [
      "controller"
    ],
    "archived": false,
    "cue_stage_id": "stage-1",
    "stages": [
      {
        "_id": "x7kp2mqa",
        "name": "Annual Conference",
        "active_timer_id": "V1StGXR8Z5jd",
        "timers_count": 1,
        "end_of_show": null,
        "end_of_show_trigger": "MANUAL",
        "end_of_show_loops": 2,
        "end_of_show_new_day": false,
        "show_run": null
      }
    ]
  }
}

POST/rooms/{room_id}/unblackout

Turn blackout off

Brings the Viewer back from blackout.

Path parameters

Name
room_id
Type
string
Required
Description
The room's id, from its address: /o/ROOM_ID/….

Request

POST

/rooms/{room_id}/unblackout

curl -X POST https://app.kloksi.com/api/v1/rooms/ROOM_ID/unblackout \
  -H "Authorization: Bearer YOUR_API_KEY"

Response 200

{
  "ok": true,
  "message": "Blackout disabled",
  "data": {
    "_id": "x7kp2mqa",
    "_model": "room",
    "_updated_at": "2026-11-05T09:30:00.000Z",
    "name": "Annual Conference",
    "date": "2026-11-05",
    "blackout": false,
    "dim": 0,
    "focus_message": false,
    "on_air": false,
    "logo": "",
    "timezone": "Europe/Berlin",
    "language": "en",
    "team_id": "6f2c1e9ab04d7c3e8a5b1d20",
    "accepting_questions": false,
    "questionnaire": {
      "logo": {
        "mode": "kloksi"
      },
      "title": "",
      "subtitle": "",
      "question_label": "",
      "name_label": "",
      "hide_name": false
    },
    "protected_outputs": [
      "controller"
    ],
    "archived": false,
    "cue_stage_id": "stage-1",
    "stages": [
      {
        "_id": "x7kp2mqa",
        "name": "Annual Conference",
        "active_timer_id": "V1StGXR8Z5jd",
        "timers_count": 1,
        "end_of_show": null,
        "end_of_show_trigger": "MANUAL",
        "end_of_show_loops": 2,
        "end_of_show_new_day": false,
        "show_run": null
      }
    ]
  }
}

POST/rooms/{room_id}/on_air

Go on air

Turns the on-air dot red on the outputs.

Path parameters

Name
room_id
Type
string
Required
Description
The room's id, from its address: /o/ROOM_ID/….

Request

POST

/rooms/{room_id}/on_air

curl -X POST https://app.kloksi.com/api/v1/rooms/ROOM_ID/on_air \
  -H "Authorization: Bearer YOUR_API_KEY"

Response 200

{
  "ok": true,
  "message": "On-air enabled",
  "data": {
    "_id": "x7kp2mqa",
    "_model": "room",
    "_updated_at": "2026-11-05T09:30:00.000Z",
    "name": "Annual Conference",
    "date": "2026-11-05",
    "blackout": false,
    "dim": 0,
    "focus_message": false,
    "on_air": false,
    "logo": "",
    "timezone": "Europe/Berlin",
    "language": "en",
    "team_id": "6f2c1e9ab04d7c3e8a5b1d20",
    "accepting_questions": false,
    "questionnaire": {
      "logo": {
        "mode": "kloksi"
      },
      "title": "",
      "subtitle": "",
      "question_label": "",
      "name_label": "",
      "hide_name": false
    },
    "protected_outputs": [
      "controller"
    ],
    "archived": false,
    "cue_stage_id": "stage-1",
    "stages": [
      {
        "_id": "x7kp2mqa",
        "name": "Annual Conference",
        "active_timer_id": "V1StGXR8Z5jd",
        "timers_count": 1,
        "end_of_show": null,
        "end_of_show_trigger": "MANUAL",
        "end_of_show_loops": 2,
        "end_of_show_new_day": false,
        "show_run": null
      }
    ]
  }
}

POST/rooms/{room_id}/off_air

Go off air

Turns the on-air indicator off.

Path parameters

Name
room_id
Type
string
Required
Description
The room's id, from its address: /o/ROOM_ID/….

Request

POST

/rooms/{room_id}/off_air

curl -X POST https://app.kloksi.com/api/v1/rooms/ROOM_ID/off_air \
  -H "Authorization: Bearer YOUR_API_KEY"

Response 200

{
  "ok": true,
  "message": "On-air disabled",
  "data": {
    "_id": "x7kp2mqa",
    "_model": "room",
    "_updated_at": "2026-11-05T09:30:00.000Z",
    "name": "Annual Conference",
    "date": "2026-11-05",
    "blackout": false,
    "dim": 0,
    "focus_message": false,
    "on_air": false,
    "logo": "",
    "timezone": "Europe/Berlin",
    "language": "en",
    "team_id": "6f2c1e9ab04d7c3e8a5b1d20",
    "accepting_questions": false,
    "questionnaire": {
      "logo": {
        "mode": "kloksi"
      },
      "title": "",
      "subtitle": "",
      "question_label": "",
      "name_label": "",
      "hide_name": false
    },
    "protected_outputs": [
      "controller"
    ],
    "archived": false,
    "cue_stage_id": "stage-1",
    "stages": [
      {
        "_id": "x7kp2mqa",
        "name": "Annual Conference",
        "active_timer_id": "V1StGXR8Z5jd",
        "timers_count": 1,
        "end_of_show": null,
        "end_of_show_trigger": "MANUAL",
        "end_of_show_loops": 2,
        "end_of_show_new_day": false,
        "show_run": null
      }
    ]
  }
}

POST/rooms/{room_id}/flash

Flash the timer

Blinks the active timer on the outputs three times.

Path parameters

Name
room_id
Type
string
Required
Description
The room's id, from its address: /o/ROOM_ID/….

Request

POST

/rooms/{room_id}/flash

curl -X POST https://app.kloksi.com/api/v1/rooms/ROOM_ID/flash \
  -H "Authorization: Bearer YOUR_API_KEY"

Response 204

204 No Content

POST/rooms/{room_id}/chime

Play a chime

Plays a bell once on the Viewer and Moderator outputs. Devices that have muted chimes stay silent.

Path parameters

Name
room_id
Type
string
Required
Description
The room's id, from its address: /o/ROOM_ID/….

Request

POST

/rooms/{room_id}/chime

curl -X POST https://app.kloksi.com/api/v1/rooms/ROOM_ID/chime \
  -H "Authorization: Bearer YOUR_API_KEY"

Response 204

204 No Content