Show, update or hide graphic

POST

/v2/overlays/{overlayId}/control-room/graphics

curl --request POST \
  --url https://api.ligr.live/rest/v2/overlays/1/control-room/graphics \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "action": "show", "presetId": 1091 }'

• LIGR REST API

Fire a control-room preset by ID. The server resolves the preset’s graphic UUID and merges its configured control-room variable values with any variableValues overrides. show puts the preset on air. update sends the same values to a preset graphic that is already on air, and returns 400 when it is not. hide takes it off air.

Authorizations

• bearer
  overlays:write
• api_key
  overlays:write

Parameters

Path Parameters

overlayId

required

Entity identifier

integer format: int32

>= 1

The overlay id

Request Body^required

Media typeapplication/json

object

action

required

show puts the preset graphic on air. update sends new values to a preset graphic that is already on air; the live values become the preset values plus variableValues. hide takes the graphic off air. For hideAll, use the /graphics/commands endpoint.

string

Allowed values: show update hide

presetId

required

Control-room graphic (preset) id. The server resolves the preset’s graphic UUID and merges its configured control-room variable values with any variableValues overrides.

number format: double

variableValues

object

key

additional properties

Any of:

string

string

number

number format: double

boolean

boolean

Example

{
  "action": "show",
  "presetId": 1091
}

Responses

200

Ok

Media typeapplication/json

object

overlayId

required

Entity identifier

integer format: int32

>= 1

manualGraphicState

required

Construct a type with a set of properties K of type T

object

Example

{
  "overlayId": 2300003,
  "manualGraphicState": {
    "Scoreboard": {
      "_ligr_presetId": 101,
      "variableValues": {
        "hide": false
      }
    }
  }
}

400

Request is invalid

Media typeapplication/json

object

message

required

string

details

required

object

key

additional properties

Example^generated

{
  "message": "example",
  "details": {
    "additionalProperty": "example"
  }
}

401

Missing or invalid api key

Media typeapplication/json

object

message

required

string

Example^generated

{
  "message": "example"
}

403

Api key provides insufficient access for the request

Media typeapplication/json

object

message

required

string

Example^generated

{
  "message": "example"
}

404

Overlay not found

Media typeapplication/json

object

message

required

string

Example^generated

{
  "message": "example"
}

429

Api key has made too many requests

Media typeapplication/json

object

message

required

string

Example^generated

{
  "message": "example"
}

500

An unexpected error has occured. If problems persist please contact support

Media typeapplication/json

object

message

required

string

Example^generated

{
  "message": "example"
}