Skip to content
Developers

Create an overlay

POST/v1/overlays

POST
/v1/overlays
curl --request POST \
  --url https://api.ligr.live/rest/v1/overlays \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "encodingDelay": 1, "matchId": 1, "autoMode": true, "adType": "free", "competitionThemeSettingId": 1, "controlRoomId": 1 }'

Create a new overlay for a match.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
name
required

Match name

string
>= 5 characters <= 42 characters
encodingDelay
integer format: int32
<= 60
matchId
required

Entity identifier

integer format: int32
>= 1
autoMode

Set false for manual control. Requires adType noBrands or brands.

boolean
adType
string
Allowed values: free brands noBrands
competitionThemeSettingId

Entity identifier

integer format: int32
>= 1
controlRoomId
integer format: int32
nullable >= 1

Responses

Section titled “Responses”

200

Section titled “200”

Ok

Media typeapplication/json
object
key
required

Stringified UUIDv4. See RFC 4112

string
/[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-4[0-9A-Fa-f]{3}-[89ABab][0-9A-Fa-f]{3}-[0-9A-Fa-f]{12}/
id
required

Entity identifier

integer format: int32
>= 1
controlRoomUrl
string
monitoringUrl

Read-only monitoring page of the new overlay on the overlay host of this environment.

string
Examplegenerated
{
  "key": "example",
  "id": 1,
  "controlRoomUrl": "example",
  "monitoringUrl": "example"
}

400

Section titled “400”

Request is invalid

Media typeapplication/json
object
message
required
string
details
required
object
key
additional properties
Examplegenerated
{
  "message": "example",
  "details": {
    "additionalProperty": "example"
  }
}

401

Section titled “401”

Missing or invalid api key

Media typeapplication/json
object
message
required
string
Examplegenerated
{
  "message": "example"
}

403

Section titled “403”

Api key provides insufficient access for the request

Media typeapplication/json
object
message
required
string
Examplegenerated
{
  "message": "example"
}

404

Section titled “404”

Overlay not found

Media typeapplication/json
object
message
required
string
Examplegenerated
{
  "message": "example"
}

429

Section titled “429”

Api key has made too many requests

Media typeapplication/json
object
message
required
string
Examplegenerated
{
  "message": "example"
}

500

Section titled “500”

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

Media typeapplication/json
object
message
required
string
Examplegenerated
{
  "message": "example"
}