Skip to main content
POST
Start a room

Authorizations

Authorization
string
header
required

An API key from Settings › API, sent as Authorization: Bearer ptr_…. Shown once when made; only a hash is stored.

Body

application/json
deckId
string
required

The deck's id

Minimum string length: 1
label
string

A name for this session, such as "Class 3B, Tuesday", so a deck used for several classes lists them apart

Required string length: 1 - 80
askName
boolean

People type their own name to join instead of getting a nickname, for marks and attendance. A name already in the room is refused, so every answer belongs to one person

keepScore
boolean

Quiz questions score and the room keeps standings. True unless you pass false, which still reveals every right answer but pays nobody

speedScores
boolean

A faster right answer is worth more, 1000 points down to 500 at the buzzer. True unless you pass false, which makes every right answer worth the same

Response

OK

code
string
required

The six-digit join code

hostToken
string
required

The host's key for this room; whoever holds it drives the session

joinUrl
string
required

Where the audience joins

presentUrl
string
required

The presenter's view, with the host key in the fragment so a person can take over