createBrowserPlayerSlot

POST

/api/v1/screens/browser

curl --request POST \
  --url https://example.com/api/v1/screens/browser \
  --header 'Content-Type: application/json' \
  --cookie tilecast_session=<tilecast_session> \
  --data '{ "name": "example", "locationId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "roomName": "example", "roomNumber": "example", "description": "example" }'

Owner or Administrator creates an awaiting Browser Player Screen. The recovery secret is returned once. Requires same-origin HTTPS and the normal dashboard mutation boundary.

Authorizations

• sessionCookie
• userBearer

Parameters

Header Parameters

X-CSRF-Token

string

Request Body^required

Media typeapplication/json

object

name

required

string

>= 2 characters <= 120 characters

locationId

string format: uuid

roomName

string

<= 120 characters

roomNumber

string

<= 80 characters

description

string

<= 1000 characters

Example^generated

{
  "name": "example",
  "locationId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "roomName": "example",
  "roomNumber": "example",
  "description": "example"
}

Responses

201

Slot and one-time launch secret response

Media typeapplication/json

object

data

required

object

id

required

string format: uuid

screenId

required

string format: uuid

recoveryEnabled

required

boolean

lastRecoveredAt

string format: date-time

recoverySecret

required

string

<= 43 characters

Example^generated

{
  "data": {
    "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "screenId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "recoveryEnabled": true,
    "lastRecoveredAt": "2026-04-15T12:00:00Z",
    "recoverySecret": "example"
  }
}

403

Administrative authorization or same-origin HTTPS required