Skip to main content
This page is generated from the API’s own reference at /llms-full.txt by scripts/developers-sync.mjs. Edit the spec, not this page.

The deck document

A deck is a JSON array of steps, at most 200. The first step is always the join screen. Steps count from 0, so the join screen is step 0 and the first slide is step 1; a person reading the editor’s filmstrip counts from 1, so their “slide 6” is step 5. A slide step is a page (or a blank) with things floating on it: up to 4 polls, 8 text boxes, 8 shapes and 4 images. A poll step is one poll filling the screen. Positions are fractions of the slide, 0 to 1. A bare array is document version 1.

Step: join

Step: slide

Step: poll

Overlay (a poll floating on a slide)

Any widget can float on a slide. Put the card over a screenshot, a picture or empty space, never over the slide’s own text; when the corner you had in mind holds text, take the one with the picture, and when the whole slide is text, use a full-screen poll step instead. A card lower than a fifth of the slide has no room for its answers. The card must stay on the slide, x + w and y + h at most 1, and the API refuses one that does not. Leave rect and style out for the house card in the bottom-right quarter. The card’s variant is read by multiple choice; the other widgets draw their own look.

Overlay card style

Text box

Shape

Image

Rect

Widgets

Every poll has a type, a prompt and, where it takes answers, options. The tables list only the properties that type reads; anything else is dropped on save. A look is chosen per widget; the first is the default. To present lists what the readiness check asks for before a room can start; a deck can be saved without it. The API runs the check for you: reading a deck answers with ready and problems, and so does every write, each problem naming the step, the card and the property.

Multiple choice (multiple-choice)

One question, up to ten answers; one pick each, or several with multiSelect. A quiz is this with a correctIndex. Looks (mcStyle): bars (default), lollipops, bubbles, spokes, butterfly, heat, arc, chord. arc needs multiSelect true. chord needs multiSelect true. Can: takes up to 10 options; its full-screen result has its own colour model (accent, colorMode, optionColors); options are coloured by identity, so a palette and a colour per option mean something; its full-screen result can print percentages (showPercent) and counts (showCount); as an overlay, the card can print percentages and counts (the card style’s showPercent, showCount). To present: Ask a question; At least two options.

Image choice (image-choice)

Multiple choice where every answer is a picture. Looks (imgStyle): tiles (default), mosaic, fill, hero. Can: takes up to 10 options; its full-screen result has its own colour model (accent, colorMode, optionColors); its full-screen result can print percentages (showPercent) and counts (showCount); as an overlay, the card can print percentages and counts (the card style’s showPercent, showCount). To present: Ask a question; At least two options.

This or that (this-or-that)

Two sides, one tap. Looks (totStyle): split (default), tug, camps. Can: takes up to 2 options; its full-screen result has its own colour model (accent, colorMode, optionColors); options are coloured by identity, so a palette and a colour per option mean something; its full-screen result can print percentages (showPercent) and counts (showCount). To present: Ask a question; At least two options.

Ranking (ranking)

People put the options in order; the result is the room’s order. Looks (rankStyle): list (default), podium, avg. Can: takes up to 10 options; its full-screen result has its own colour model (accent, colorMode, optionColors); options are coloured by identity, so a palette and a colour per option mean something; its full-screen result can print percentages (showPercent) and counts (showCount). To present: Ask a question; At least two options.

100 points (hundred-points)

Everyone spends 100 points across the options. Looks (hpStyle): bars (default), treemap, waffle, columns, sunburst, marimekko, icicle, bullet. sunburst, marimekko, icicle use groups, one entry per option. bullet use targets, one entry per option. Can: takes up to 10 options; its full-screen result has its own colour model (accent, colorMode, optionColors); options are coloured by identity, so a palette and a colour per option mean something; its full-screen result can print percentages (showPercent) and counts (showCount). To present: Ask a question; At least two options.

Star rating (rating)

One to five stars. Looks (scaleStyle): stars (default), faces, breakdown, gauge, curve, bloom. Can: its full-screen result has its own colour model (accent, colorMode, optionColors); its full-screen result can print counts (showCount); as an overlay, the card can print counts (the card style’s showPercent, showCount). To present: Ask a question.

NPS 0–10 (nps)

How likely to recommend, 0 to 10, scored the NPS way. Looks (npsStyle): score (default), needle, diverging, swarm. Can: its full-screen result has its own colour model (accent, colorMode, optionColors). To present: Ask a question.

Estimate (estimate)

Everyone guesses a number inside a range; the real answer is revealed when the poll closes. Looks (estStyle): hist (default), curve, dots, range. Can: its full-screen result has its own colour model (accent, colorMode, optionColors). To present: Ask a question; Set the guess range.

Radar (radar)

Three to eight axes rated 1 to 5, drawn as a radar. Can: its full-screen result has its own colour model (accent, colorMode, optionColors). To present: Ask a question; At least three axes.

Word cloud (word-cloud)

A word or a few per person, sized by how often they come up. Looks (wcStyle): cloud (default), wordle, bubbles. Can: its full-screen result has its own colour model (accent, colorMode, optionColors); its full-screen result can print counts (showCount); as an overlay, the card can print counts (the card style’s showPercent, showCount). To present: Ask a question.

Open feed (open-feed)

Free text from the room, shown as it arrives. Looks (ofStyle): feed (default), cards, bubbles. Can: its full-screen result has its own colour model (accent, colorMode, optionColors). To present: Ask a question.

Q&A (qa-upvotes)

Questions from the room, upvoted to the top. Looks (qaStyle): list (default), spotlight. To present: Ask a question.

Timer (timer)

A shared countdown on the big screen. Takes no answers. To present: Ask a question.

Spin the wheel (wheel)

Spins between everyone in the room, or a custom list, and picks one. Can: options are coloured by identity, so a palette and a colour per option mean something. To present: Ask a question; Add at least two names for the wheel.

Live map (map)

Where people are joining from, on a fixed list of countries. Looks (mapStyle): pins (default), heat, bars. Can: its full-screen result has its own colour model (accent, colorMode, optionColors). To present: Ask a question.

Place map (place-map)

A real map of one place; everyone drops a pin on it. To present: Ask a question; Pick a place.

Rounds (rounds)

Compares the results of earlier polls in the deck. Takes no answers. Looks (roundsMode): bump (default), stream, slope, dumbbell. Can: its full-screen result has its own colour model (accent, colorMode, optionColors). To present: Ask a question.

Limits

  • 200 steps per deck; one PDF behind them, up to 60 pages.
  • Per slide: 4 polls, 8 text boxes, 8 shapes, 4 images.
  • Images travel as data URLs: up to 12 MB for an image on a slide, 500 KB per option image.