Send a graphics command

POST

/v2/overlays/{overlayId}/graphics/commands

curl --request POST \
  --url https://api.ligr.live/rest/v2/overlays/1/graphics/commands \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "command": "hideAll" }'

• LIGR REST API

Fire a show, hide, update, or hideAll command on a graphic by UUID or name. Pass variableValues to set values directly. For control-room preset semantics (automatic defaults resolution), use /control-room/graphics instead.

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

command

required

Action to perform on the graphic.

string

Allowed values: show hide hideAll update

graphicUuid

Graphic UUID. Used directly as the key in manualGraphicState — no lookup. Exactly one of graphicUuid or name is required for any command except hideAll; if both are provided, graphicUuid wins.

string

name

Graphic human name (as configured in the theme). The server looks it up in the overlay’s theme and resolves to the UUID before dispatching. Must be a graphic name, not a UUID — pass UUIDs via graphicUuid.

string

variableValues

object

key

additional properties

Any of:

string

string

number

number format: double

boolean

boolean

Example

{
  "command": "hideAll"
}

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"
}