Docs
GraphQL referenceMutations

Start Live Session

MUTATIONstartLiveSession(input: StartLiveSessionInput!): LiveSessionMutationOutput!

Access: Requires the streams:write permission. Requires the cloud station add-on.

Arguments

input*

Returns

  1. startLiveSession
message?String
session?
success*Boolean!
Example Request
mutation StartLiveSession($input: StartLiveSessionInput!) {  startLiveSession(input: $input) {    message    session {      createdAt      endedAt      generation      id      queue {        createdAt        id        position        shortId        status      }      shortId      skipNonce      startedAt      startedByUserId      stream {        activeListeners        config        createdAt        desiredState        enabled        hdEnabled        id        listenerAccess      }    }    success  }}
Variables
{  "input": {    "streamId": "1"  }}
Example Response
{  "data": {    "startLiveSession": {      "message": "string",      "session": {        "createdAt": "<DateTime>",        "endedAt": "<DateTime>",        "generation": 10,        "id": "1",        "queue": [          {            "createdAt": "<DateTime>",            "id": "1",            "position": 10,            "shortId": "string",            "status": "PENDING"          }        ],        "shortId": "string",        "skipNonce": 10,        "startedAt": "<DateTime>",        "startedByUserId": "string",        "stream": {          "activeListeners": 10,          "config": "<JSON>",          "createdAt": "<DateTime>",          "desiredState": "ACTIVE",          "enabled": true,          "hdEnabled": true,          "id": "1",          "listenerAccess": "FREE"        }      },      "success": true    }  }}

Start Listen Session MUTATION

**Access:** Public: no sign-in required.

Start Music Scheduling Job MUTATION

**Access:** Requires the `music_schedule:generate` permission. Requires the music scheduling add-on.