Skip to main content
POST
Join Play Session

Authorizations

Authorization
string
header
required

Bearer token issued by Softmax

Path Parameters

session_id
string
required
Pattern: ^ps_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Query Parameters

spectate
boolean
default:false
entrant_id
string<uuid> | null

Response

Successful Response

entrant_kind
enum<string>
required
Available options:
player,
spectator
target_url
string
required
slot
integer | null
player
PlaySessionPlayerResponse · object | null
spectator
PlaySessionSpectatorResponse · object | null