Set stream automation

POST

/v1/streams/{streamSettingsId}/automation

curl --request POST \
  --url https://api.ligr.live/rest/v1/streams/1/automation \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "autoStream": true }'

• LIGR REST API

Turns Auto Stream on or off. With it on, the stream starts and stops at the automation times of the match. The match needs pregame and postgame automation times first. Auto Graphics is the autoMode field of the overlay. See update overlay.

Authorizations

• bearer
  streams:write
• api_key
  streams:write

Parameters

Path Parameters

streamSettingsId

required

Entity identifier

integer format: int32

>= 1

The stream settings identifier

Request Body^required

Media typeapplication/json

object

autoStream

required

Auto Stream. When true, the stream starts and stops at the automation times of the match. The match needs pregame and postgame automation times first.

boolean

Example^generated

{
  "autoStream": true
}

Responses

200

Ok

Media typeapplication/json

object

streamSettingsId

required

Entity identifier

integer format: int32

>= 1

autoStream

required

boolean

Example^generated

{
  "streamSettingsId": 1,
  "autoStream": true
}

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

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