Skip to main content
GET
Screenshot a step

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

id
string
required

The deck's id

Minimum string length: 1
index
integer
required

The step's index; the join screen (0) has no picture

Required range: 1 <= x <= 9007199254740991

Query Parameters

scale
integer

1 (the default) for 1600 pixels wide, 2 for 3200

Required range: 1 <= x <= 2
element
string

Crop to this element, as get_step names it: "overlay 0", "text 1"

Pattern: ^(overlay|text|shape|image) \d+$
annotate

Draw every element's box and name on the picture, clashes in red

Response

OK

png
string
required

The image, as a data URL

width
integer
required

Pixels

Required range: -9007199254740991 <= x <= 9007199254740991
height
integer
required

Pixels

Required range: -9007199254740991 <= x <= 9007199254740991
revision
string
required

The deck's revision this picture shows

elements
object[]
required
overlaps
object[]
required

Pairs of elements that sit on top of each other; empty when nothing overlaps

warnings
object[]
required

What on this slide will not read well: a card too small to read, a card or text box over another

coversPageText
object[]
required

Cards and text boxes over the PDF page's own text. Words drawn inside a picture on the page are pixels, not text, so look at the picture for those

measured
object[]
required

Each card and text box as the drawing measured it after paint. How small a card can go depends on its look, so this, not a fraction, says whether it fits