Skip to main content
POST
Drive 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.

Path Parameters

code
string
required

The room's six-digit code

Pattern: ^\d{6}$

Body

application/json
action
enum<string>
required

start, next, prev, close or stop

Available options:
start,
next,
prev,
close,
stop

Response

OK

status
enum<string>
required
Available options:
lobby,
presenting,
ended
stepIndex
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
stepCount
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991