Start Quick Present
POST
/api/v1/presentation-overrides
const url = 'https://example.com/api/v1/presentation-overrides';const options = { method: 'POST', headers: { cookie: 'tilecast_session=<tilecast_session>', 'Content-Type': 'application/json' }, body: '{"targetType":"screen","targetId":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","contentType":"playlist","contentId":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","durationMinutes":0,"afterAction":"resume","wakeDisplay":true}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://example.com/api/v1/presentation-overrides \ --header 'Content-Type: application/json' \ --cookie tilecast_session=<tilecast_session> \ --data '{ "targetType": "screen", "targetId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "contentType": "playlist", "contentId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "durationMinutes": 0, "afterAction": "resume", "wakeDisplay": true }'Requires an authenticated dashboard user.
Authorizations
Section titled “Authorizations”Parameters
Section titled “ Parameters ”Header Parameters
Section titled “Header Parameters”X-CSRF-Token
string
Cookie-backed browser requests only, and only on unsafe methods. Bearer grants never send it.
Request Bodyrequired
Section titled “Request Bodyrequired”Media typeapplication/json
object
targetType
required
string
targetId
required
string format: uuid
contentType
required
string
contentId
required
string format: uuid
durationMinutes
required
integer
afterAction
required
string
wakeDisplay
required
boolean
Responses
Section titled “ Responses ”Quick Present started
Media typeapplication/json
object
data
required
Active Quick Present session. The stopped timestamp and reason appear once the session ends.
object
id
required
string format: uuid
targetType
required
string
targetId
required
string format: uuid
targetName
required
string
contentType
required
string
contentId
required
string format: uuid
contentName
required
string
durationSeconds
required
integer
startedAt
required
string format: date-time
expiresAt
string format: date-time
afterAction
required
string
wakeDisplay
required
boolean
stoppedAt
string format: date-time
stopReason
string
Example
{ "data": { "targetType": "screen", "contentType": "playlist", "afterAction": "resume" }}Dashboard authentication required
Destination conflicts with AirPlay or another temporary presentation
Destination or content validation failed