Skip to main content
POST
Create a deck

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
title
string
default:Untitled deck

The deck's name

Required string length: 1 - 200
document
object[]

The deck document (see DeckDocument). Omit for a blank deck.

Maximum array length: 200

The mandatory opener: the code and QR while the room fills. Always first.

Response

OK

id
string
required
url
string
required

Where a person opens it in the editor

ready
boolean
required

Every poll passes the readiness check, so a room can start

problems
object[]
required

What stops it, by step; empty when ready

warnings
object[]
required

Placements that will not read well on stage, by step: a card smaller than a fifth of the slide either way, or a card or text box over another card or text box. They do not stop a room; fix them anyway

revision
string
required

The deck's revision after this write; send it as revision with the next write to be sure nobody changed the deck in between