Every step in a line: kind, page, notes, and for a slide every element’s rect and label, which elements cover each other, and its warnings, without the pictures’ bytes. Read this first to find your way around a deck, the way Paper’s get_tree_summary reads a file; get_deck returns the whole document, images included.
The deck's revision after this write; send it as revision with the next write to be sure nobody changed the deck in between
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Poll the Room","description":"Live polls on a presenter's own slides. Build decks, put polls on slides, run rooms and read results, from code or from an AI agent.","colors":{"primary":"#3333ff","light":"#8f8fff","dark":"#3333ff"},"logo":{"light":"https://mintcdn.com/polltheroom/wm5nU6Sq7YIILBAr/logo/light.svg?fit=max\u0026auto=format\u0026n=wm5nU6Sq7YIILBAr\u0026q=85\u0026s=9ba2b3ce482ba5c06a0fa3c750a47acd","dark":"https://mintcdn.com/polltheroom/wm5nU6Sq7YIILBAr/logo/dark.svg?fit=max\u0026auto=format\u0026n=wm5nU6Sq7YIILBAr\u0026q=85\u0026s=08ce6c0b4945f87688866fe6a49adbc6","href":"https://test.polltheroom.com"},"favicon":"https://mintcdn.com/polltheroom/Beb7336SfQDVOA4K/favicon.svg?fit=max\u0026auto=format\u0026n=Beb7336SfQDVOA4K\u0026q=85\u0026s=b62f27bdae4382c39a777ea188ce3b68","appearance":{"default":"light","strict":true},"navbar":{"links":[{"href":"https://test.polltheroom.com","label":"Open Poll the Room"}],"primary":{"type":"button","label":"Get an API key","href":"https://test.polltheroom.com/settings/api"}},"footer":{"socials":{"website":"https://test.polltheroom.com"}},"seo":{"metatags":{"robots":"noindex"}},"fonts":{"family":"Inter"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"polltheroom","hasAudioNarration":false,"actualSubdomain":"polltheroom","customDomains":["dev.polltheroom.com"],"gitSource":{"type":"github","owner":"internetoftoday","repo":"polltheroom","deployBranch":"docs","contentDirectory":"developers","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6ad4a9629d4e735aef35504f","clientVersion":"0.0.4088","searchFilterCounts":[{"language":"default","tag":"API reference","count":27},{"language":"default","tag":"decks","count":21},{"language":"default","tag":"Guides","count":15},{"language":"default","tag":"rooms","count":5},{"language":"default","tag":"Concepts","count":4},{"language":"default","tag":"Get started","count":3},{"language":"default","tag":"Reference","count":2},{"language":"default","tag":"MCP","count":2},{"language":"default","tag":"MCP server","count":2},{"language":"default","tag":"Start here","count":1}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/decks/outline-a-deck","slug":"/api-reference/decks/outline-a-deck","pageMetadata":{"title":"Outline a deck","description":"Every step in a line: kind, page, notes, and for a slide every element's rect and label, which elements cover each other, and its warnings, without the pictures' bytes. Read this first to find your way around a deck, the way Paper's get_tree_summary reads a file; get_deck returns the whole document, images included.\n\nNeeds the `decks:read` scope.","deprecated":null,"version":null,"openapi":"https://test.polltheroom.com/openapi.json get /api/v1/decks/{id}/outline","href":"/api-reference/decks/outline-a-deck","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Every step in a line: kind, page, notes, and for a slide every element’s rect and label, which elements cover each other, and its warnings, without the pictures’ bytes. Read this first to find your way around a deck, the way Paper’s get_tree_summary reads a file; get_deck returns the whole document, images included.\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"Needs the \", _jsx(_components.code, {\n children: \"decks:read\"\n }), \" scope.\"]\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Outline a deck","description":"Every step in a line: kind, page, notes, and for a slide every element's rect and label, which elements cover each other, and its warnings, without the pictures' bytes. Read this first to find your way around a deck, the way Paper's get_tree_summary reads a file; get_deck returns the whole document, images included.\n\nNeeds the `decks:read` scope.","deprecated":null,"version":null,"openapi":"https://test.polltheroom.com/openapi.json get /api/v1/decks/{id}/outline","href":"/api-reference/decks/outline-a-deck","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"get_outline","summary":"Outline a deck","description":"Every step in a line: kind, page, notes, and for a slide every element's rect and label, which elements cover each other, and its warnings, without the pictures' bytes. Read this first to find your way around a deck, the way Paper's get_tree_summary reads a file; get_deck returns the whole document, images included.\n\nNeeds the `decks:read` scope.","x-scope":"decks:read","tags":["decks"],"parameters":["476ba816-7466-49b2-825f-a25b04d56ef5"],"responses":{"200":"f01d50d7-d528-4eb1-9b50-749388b94b5a","401":"8459cf86-9d46-47fe-b6f5-804cedc64ccb","403":"9c77ee91-69d2-4ed4-aeaf-cc7ee2ba14fe","404":"cbd824b3-db0d-4063-b871-db76c0e72022","429":"05b299b3-44a9-42ba-b869-0ddf989697b6"},"method":"get","type":"path","servers":["5817ffd4-0b64-4c93-a98d-913208924ee1"],"security":["7162788f-04d2-4ba0-9f6c-593e2d5b4e6f"],"path":"/api/v1/decks/{id}/outline","baseUrlOptions":["https://test.polltheroom.com"],"title":"Outline a deck","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"476ba816-7466-49b2-825f-a25b04d56ef5":{"name":"id","in":"path","required":true,"schema":{"type":"string","minLength":1,"description":"The deck's id","isRequired":true,"uniqueKey":"","typeLabel":"string"},"example":"cmtwzaz21009juqmfmvygdi2b"}},"responses":{"f01d50d7-d528-4eb1-9b50-749388b94b5a":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"title":{"type":"string","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"steps":{"type":"array","items":{"type":"object","properties":{"index":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"isRequired":true,"uniqueKey":"steps.items.[INDEX].index","typeLabel":"integer"},"kind":{"type":"string","enum":["join","slide","poll"],"isRequired":true,"uniqueKey":"steps.items.[INDEX].kind","typeLabel":"enum\u003cstring>"},"elements":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"\"overlay 0\", \"text 1\": the list and the index, as the step verbs address it","isRequired":true,"uniqueKey":"steps.items.[INDEX].elements.items.[INDEX].id","typeLabel":"string"},"kind":{"type":"string","enum":["overlay","text","shape","image"],"isRequired":true,"uniqueKey":"steps.items.[INDEX].elements.items.[INDEX].kind","typeLabel":"enum\u003cstring>"},"index":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"isRequired":true,"uniqueKey":"steps.items.[INDEX].elements.items.[INDEX].index","typeLabel":"integer"},"rect":{"type":"object","properties":{"x":{"type":"number","minimum":0,"maximum":1,"isRequired":true,"uniqueKey":"steps.items.[INDEX].elements.items.[INDEX].rect.x","typeLabel":"number"},"y":{"type":"number","minimum":0,"maximum":1,"isRequired":true,"uniqueKey":"steps.items.[INDEX].elements.items.[INDEX].rect.y","typeLabel":"number"},"w":{"type":"number","minimum":0.02,"maximum":1,"isRequired":true,"uniqueKey":"steps.items.[INDEX].elements.items.[INDEX].rect.w","typeLabel":"number"},"h":{"type":"number","minimum":0.02,"maximum":1,"isRequired":true,"uniqueKey":"steps.items.[INDEX].elements.items.[INDEX].rect.h","typeLabel":"number"}},"required":["x","y","w","h"],"additionalProperties":false,"isRequired":true,"uniqueKey":"steps.items.[INDEX].elements.items.[INDEX].rect","typeLabel":"object"},"z":{"type":"number","description":"Stacking order; higher is on top","isRequired":true,"uniqueKey":"steps.items.[INDEX].elements.items.[INDEX].z","typeLabel":"number"},"label":{"type":"string","description":"The card's question, the text box's first words, the shape's kind, or image","isRequired":true,"uniqueKey":"steps.items.[INDEX].elements.items.[INDEX].label","typeLabel":"string"}},"required":["id","kind","index","rect","z","label"],"additionalProperties":false,"uniqueKey":"steps.items.[INDEX].elements.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"steps.items.[INDEX].elements","typeLabel":"object[]"},"overlaps":{"type":"array","items":{"type":"object","properties":{"a":{"type":"string","isRequired":true,"uniqueKey":"steps.items.[INDEX].overlaps.items.[INDEX].a","typeLabel":"string"},"b":{"type":"string","isRequired":true,"uniqueKey":"steps.items.[INDEX].overlaps.items.[INDEX].b","typeLabel":"string"},"covered":{"type":"number","description":"How much of the smaller element the other covers, 0 to 1","isRequired":true,"uniqueKey":"steps.items.[INDEX].overlaps.items.[INDEX].covered","typeLabel":"number"}},"required":["a","b","covered"],"additionalProperties":false,"uniqueKey":"steps.items.[INDEX].overlaps.items.[INDEX]","typeLabel":"object"},"description":"Pairs of elements that sit on top of each other; empty when nothing overlaps","isRequired":true,"uniqueKey":"steps.items.[INDEX].overlaps","typeLabel":"object[]"},"warnings":{"type":"array","items":{"type":"object","properties":{"element":{"type":"string","description":"The element it is about, \"overlay 0\", \"text 1\"","isRequired":true,"uniqueKey":"steps.items.[INDEX].warnings.items.[INDEX].element","typeLabel":"string"},"message":{"type":"string","description":"What is wrong and what to do","isRequired":true,"uniqueKey":"steps.items.[INDEX].warnings.items.[INDEX].message","typeLabel":"string"},"with":{"description":"The other element, for an overlap","type":"string","uniqueKey":"steps.items.[INDEX].warnings.items.[INDEX].with","typeLabel":"string"}},"required":["element","message"],"additionalProperties":false,"uniqueKey":"steps.items.[INDEX].warnings.items.[INDEX]","typeLabel":"object"},"description":"What on this slide will not read well: a card too small to read, a card or text box over another","isRequired":true,"uniqueKey":"steps.items.[INDEX].warnings","typeLabel":"object[]"},"pageIndex":{"oneOf":[{"type":"integer","description":"The page behind a slide; null is a blank slide","maximum":9007199254740991,"minimum":-9007199254740991,"uniqueKey":"steps.items.[INDEX].pageIndex.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The page behind a slide; null is a blank slide","uniqueKey":"steps.items.[INDEX].pageIndex.oneOf.1","typeLabel":"null"}],"uniqueKey":"steps.items.[INDEX].pageIndex","typeLabel":"integer | null"},"poll":{"description":"A full-screen poll step's poll","type":"object","properties":{"type":{"type":"string","isRequired":true,"uniqueKey":"steps.items.[INDEX].poll.type","typeLabel":"string"},"prompt":{"type":"string","isRequired":true,"uniqueKey":"steps.items.[INDEX].poll.prompt","typeLabel":"string"}},"required":["type","prompt"],"additionalProperties":false,"uniqueKey":"steps.items.[INDEX].poll","typeLabel":"object"},"notes":{"type":"string","uniqueKey":"steps.items.[INDEX].notes","typeLabel":"string"}},"required":["index","kind","elements","overlaps","warnings"],"additionalProperties":false,"uniqueKey":"steps.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"steps","typeLabel":"object[]"},"ready":{"type":"boolean","description":"Every poll passes the readiness check, so a room can start","isRequired":true,"uniqueKey":"ready","typeLabel":"boolean"},"problems":{"type":"array","items":{"type":"object","properties":{"step":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"The step's index; 0 is the join screen","isRequired":true,"uniqueKey":"problems.items.[INDEX].step","typeLabel":"integer"},"path":{"type":"string","description":"The property, from the step","isRequired":true,"uniqueKey":"problems.items.[INDEX].path","typeLabel":"string"},"message":{"type":"string","description":"What to do, in the editor's words","isRequired":true,"uniqueKey":"problems.items.[INDEX].message","typeLabel":"string"},"overlay":{"description":"Which card on the slide, when it is one","type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"uniqueKey":"problems.items.[INDEX].overlay","typeLabel":"integer"}},"required":["step","path","message"],"additionalProperties":false,"uniqueKey":"problems.items.[INDEX]","typeLabel":"object"},"description":"What stops it, by step; empty when ready","isRequired":true,"uniqueKey":"problems","typeLabel":"object[]"},"revision":{"type":"string","description":"The deck's revision after this write; send it as `revision` with the next write to be sure nobody changed the deck in between","isRequired":true,"uniqueKey":"revision","typeLabel":"string"}},"required":["title","steps","ready","problems","revision"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"example":{"title":"Town hall, September","steps":[{"index":0,"kind":"slide","pageIndex":null,"elements":[{"id":"text 0","kind":"text","index":0,"rect":{"h":0.14,"w":0.5,"x":0.06,"y":0.1},"z":40,"label":"Q3 kick-off"}],"overlaps":[],"warnings":[]},{"index":1,"kind":"poll","poll":{"type":"multiple-choice","prompt":"Which bet do we start with?"},"elements":[],"overlaps":[],"warnings":[]},{"index":2,"kind":"poll","poll":{"type":"word-cloud","prompt":"One word to take home?"},"elements":[],"overlaps":[],"warnings":[]}],"ready":true,"problems":[],"revision":"2026-09-11T13:15:14.098Z"},"examples":{"Example":{"title":"Example","value":{"title":"Town hall, September","steps":[{"index":0,"kind":"slide","pageIndex":null,"elements":[{"id":"text 0","kind":"text","index":0,"rect":{"h":0.14,"w":0.5,"x":0.06,"y":0.1},"z":40,"label":"Q3 kick-off"}],"overlaps":[],"warnings":[]},{"index":1,"kind":"poll","poll":{"type":"multiple-choice","prompt":"Which bet do we start with?"},"elements":[],"overlaps":[],"warnings":[]},{"index":2,"kind":"poll","poll":{"type":"word-cloud","prompt":"One word to take home?"},"elements":[],"overlaps":[],"warnings":[]}],"ready":true,"problems":[],"revision":"2026-09-11T13:15:14.098Z"}}},"exampleType":"examples"}},"exampleType":"examples"},"8459cf86-9d46-47fe-b6f5-804cedc64ccb":{"description":"No usable key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"What went wrong, in a sentence","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"fix":{"description":"What to do about it, when we can tell","type":"string","uniqueKey":"fix","typeLabel":"string"}},"required":["error"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","fix":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"9c77ee91-69d2-4ed4-aeaf-cc7ee2ba14fe":{"description":"The key lacks the scope, or the plan does not sell it.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"What went wrong, in a sentence","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"fix":{"description":"What to do about it, when we can tell","type":"string","uniqueKey":"fix","typeLabel":"string"}},"required":["error"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","fix":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"cbd824b3-db0d-4063-b871-db76c0e72022":{"description":"Nothing by that id within this key's reach.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"What went wrong, in a sentence","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"fix":{"description":"What to do about it, when we can tell","type":"string","uniqueKey":"fix","typeLabel":"string"}},"required":["error"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","fix":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"05b299b3-44a9-42ba-b869-0ddf989697b6":{"description":"Over the key's hourly limit.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"What went wrong, in a sentence","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"fix":{"description":"What to do about it, when we can tell","type":"string","uniqueKey":"fix","typeLabel":"string"}},"required":["error"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","fix":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"7162788f-04d2-4ba0-9f6c-593e2d5b4e6f":{"apiKey":{"type":"http","scheme":"bearer","description":"An API key from Settings › API, sent as `Authorization: Bearer ptr_…`. Shown once when made; only a hash is stored.","scopes":[],"schemeName":"apiKey"}}},"servers":{"5817ffd4-0b64-4c93-a98d-913208924ee1":{"url":"https://test.polltheroom.com"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"An API key from Settings › API, sent as `Authorization: Bearer ptr_…`. Shown once when made; only a hash is stored.","scopes":[],"schemeName":"apiKey"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"An API key from Settings › API, sent as `Authorization: Bearer ptr_…`. Shown once when made; only a hash is stored.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"apiKey","name":"Authorization"}],"title":"apiKey"}]},"originalFileLocation":"https://test.polltheroom.com/openapi.json"},"subdomain":"polltheroom","siteName":"Poll the Room","title":"Outline a deck - Poll the Room","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-14T14:49:04.932Z","originalFileLocation":"api-reference/decks/outline-a-deck.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=\"light\";if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"light\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Every step in a line: kind, page, notes, and for a slide every element\u0026#x27;s rect and label, which elements cover each other, and its warnings, without the pictures\u0026#x27; bytes. Read this first to find your way around a deck, the way Paper\u0026#x27;s get_tree_summary reads a file; get_deck returns the whole document, images included. Needs the decks:read scope.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Poll the Room\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003cmeta data-mint-head name=\"robots\" content=\"noindex\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/polltheroom/7KTc0c_TZbUysiH7/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/polltheroom/7KTc0c_TZbUysiH7/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/polltheroom/7KTc0c_TZbUysiH7/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/polltheroom/7KTc0c_TZbUysiH7/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/polltheroom/7KTc0c_TZbUysiH7/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/polltheroom/7KTc0c_TZbUysiH7/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/polltheroom/7KTc0c_TZbUysiH7/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/polltheroom/7KTc0c_TZbUysiH7/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/polltheroom/7KTc0c_TZbUysiH7/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Outline a deck - Poll the Room\">\u003cmeta data-mint-head property=\"og:description\" content=\"Every step in a line: kind, page, notes, and for a slide every element\u0026#x27;s rect and label, which elements cover each other, and its warnings, without the pictures\u0026#x27; bytes. Read this first to find your way around a deck, the way Paper\u0026#x27;s get_tree_summary reads a file; get_deck returns the whole document, images included. Needs the decks:read scope.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Poll the Room\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://dev.polltheroom.com/api-reference/decks/outline-a-deck\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://polltheroom.mintlify.site/_mintlify/api/og/v2?division=decks\u0026amp;title=Outline+a+deck\u0026amp;description=Every+step+in+a+line%3A+kind%2C+page%2C+notes%2C+and+for+a+slide+every+element%27s+rect+and+label%2C+which+elements+cover+each+other%2C+and+its+warnings%2C+without+the+pictures\u0026amp;theme=625264d4e40254fb4eb43184\u0026amp;signature=65690a1d0e5654627a0b8ca188f7979a7571a04d8d8d66e2e1401592a932dcd8\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Outline a deck - Poll the Room\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Every step in a line: kind, page, notes, and for a slide every element\u0026#x27;s rect and label, which elements cover each other, and its warnings, without the pictures\u0026#x27; bytes. Read this first to find your way around a deck, the way Paper\u0026#x27;s get_tree_summary reads a file; get_deck returns the whole document, images included. Needs the decks:read scope.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://polltheroom.mintlify.site/_mintlify/api/og/v2?division=decks\u0026amp;title=Outline+a+deck\u0026amp;description=Every+step+in+a+line%3A+kind%2C+page%2C+notes%2C+and+for+a+slide+every+element%27s+rect+and+label%2C+which+elements+cover+each+other%2C+and+its+warnings%2C+without+the+pictures\u0026amp;theme=625264d4e40254fb4eb43184\u0026amp;signature=65690a1d0e5654627a0b8ca188f7979a7571a04d8d8d66e2e1401592a932dcd8\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/polltheroom/7KTc0c_TZbUysiH7/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Poll the Room\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#3333ff\">\u003clink data-mint-head rel=\"canonical\" href=\"https://dev.polltheroom.com/api-reference/decks/outline-a-deck\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/decks/outline-a-deck.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://dev.polltheroom.com/#organization\",\"name\":\"Poll the Room\",\"url\":\"https://dev.polltheroom.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/polltheroom/wm5nU6Sq7YIILBAr/logo/light.svg?fit=max\u0026auto=format\u0026n=wm5nU6Sq7YIILBAr\u0026q=85\u0026s=9ba2b3ce482ba5c06a0fa3c750a47acd\"}},{\"@type\":\"WebSite\",\"@id\":\"https://dev.polltheroom.com#website\",\"name\":\"Poll the Room\",\"url\":\"https://dev.polltheroom.com\",\"publisher\":{\"@id\":\"https://dev.polltheroom.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://dev.polltheroom.com/api-reference/decks/outline-a-deck#webpage\",\"url\":\"https://dev.polltheroom.com/api-reference/decks/outline-a-deck\",\"name\":\"Outline a deck\",\"description\":\"Every step in a line: kind, page, notes, and for a slide every element's rect and label, which elements cover each other, and its warnings, without the pictures' bytes. Read this first to find your way around a deck, the way Paper's get_tree_summary reads a file; get_deck returns the whole document, images included. Needs the decks:read scope.\",\"dateModified\":\"2026-10-14T14:49:04.932Z\",\"isPartOf\":{\"@id\":\"https://dev.polltheroom.com#website\"},\"breadcrumb\":{\"@id\":\"https://dev.polltheroom.com/api-reference/decks/outline-a-deck#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://dev.polltheroom.com/api-reference/decks/outline-a-deck#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"decks\",\"item\":\"https://dev.polltheroom.com/api-reference/decks/list-decks\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Outline a deck\",\"item\":\"https://dev.polltheroom.com/api-reference/decks/outline-a-deck\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://dev.polltheroom.com/api-reference/decks/outline-a-deck#apireference\",\"headline\":\"Outline a deck\",\"name\":\"Outline a deck\",\"description\":\"Every step in a line: kind, page, notes, and for a slide every element's rect and label, which elements cover each other, and its warnings, without the pictures' bytes. Read this first to find your way around a deck, the way Paper's get_tree_summary reads a file; get_deck returns the whole document, images included. Needs the decks:read scope.\",\"url\":\"https://dev.polltheroom.com/api-reference/decks/outline-a-deck\",\"mainEntityOfPage\":{\"@id\":\"https://dev.polltheroom.com/api-reference/decks/outline-a-deck#webpage\"},\"dateModified\":\"2026-10-14T14:49:04.932Z\",\"publisher\":{\"@id\":\"https://dev.polltheroom.com/#organization\"},\"isPartOf\":{\"@id\":\"https://dev.polltheroom.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Poll the Room\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Poll the Room","nav":{"global":null,"tabs":[{"tab":"Guides","icon":"book-open","pages":[{"title":"Guides","href":""}]},{"tab":"MCP","icon":"plug","pages":[{"title":"MCP","href":"/mcp-server"}]},{"tab":"API reference","icon":"square-terminal","groups":[{"group":"Start here","pages":[{"title":"Introduction","href":"/api-reference/introduction"}]},{"group":"decks","pages":[{"title":"List decks","deprecated":null,"version":null,"openapi":"https://test.polltheroom.com/openapi.json get /api/v1/decks","href":"/api-reference/decks/list-decks"},{"title":"Create a deck","deprecated":null,"version":null,"openapi":"https://test.polltheroom.com/openapi.json post /api/v1/decks","href":"/api-reference/decks/create-a-deck"},{"title":"Get a deck","deprecated":null,"version":null,"openapi":"https://test.polltheroom.com/openapi.json get /api/v1/decks/{id}","href":"/api-reference/decks/get-a-deck"},{"title":"Bin a deck","deprecated":null,"version":null,"openapi":"https://test.polltheroom.com/openapi.json delete /api/v1/decks/{id}","href":"/api-reference/decks/bin-a-deck"},{"title":"Change a deck","deprecated":null,"version":null,"openapi":"https://test.polltheroom.com/openapi.json patch /api/v1/decks/{id}","href":"/api-reference/decks/change-a-deck"},{"title":"Add a step","deprecated":null,"version":null,"openapi":"https://test.polltheroom.com/openapi.json post /api/v1/decks/{id}/steps","href":"/api-reference/decks/add-a-step"},{"title":"Read one step","deprecated":null,"version":null,"openapi":"https://test.polltheroom.com/openapi.json get /api/v1/decks/{id}/steps/{index}","href":"/api-reference/decks/read-one-step"},{"title":"Replace a step","deprecated":null,"version":null,"openapi":"https://test.polltheroom.com/openapi.json put /api/v1/decks/{id}/steps/{index}","href":"/api-reference/decks/replace-a-step"},{"title":"Remove a step","deprecated":null,"version":null,"openapi":"https://test.polltheroom.com/openapi.json delete /api/v1/decks/{id}/steps/{index}","href":"/api-reference/decks/remove-a-step"},{"title":"Put a poll on a slide","description":"Drop a poll onto a slide as a floating card, the way the editor does: send the poll, and optionally where (rect) and how it is drawn (style); what you leave out gets the house default. The slide's other content is untouched. For a poll that fills the screen, use add_step instead.\n\nNeeds the `decks:write` scope.","deprecated":null,"version":null,"openapi":"https://test.polltheroom.com/openapi.json post /api/v1/decks/{id}/steps/{index}/overlays","href":"/api-reference/decks/put-a-poll-on-a-slide"},{"title":"Outline a deck","deprecated":null,"version":null,"openapi":"https://test.polltheroom.com/openapi.json get /api/v1/decks/{id}/outline","href":"/api-reference/decks/outline-a-deck"},{"title":"Take a card off a slide","description":"Remove one card from a slide; everything else on the slide stays. Read the card's index with get_step.\n\nNeeds the `decks:write` scope.","deprecated":null,"version":null,"openapi":"https://test.polltheroom.com/openapi.json delete /api/v1/decks/{id}/steps/{index}/overlays/{card}","href":"/api-reference/decks/take-a-card-off-a-slide"},{"title":"Change a card","deprecated":null,"version":null,"openapi":"https://test.polltheroom.com/openapi.json patch /api/v1/decks/{id}/steps/{index}/overlays/{card}","href":"/api-reference/decks/change-a-card"},{"title":"Put text, a shape or a picture on a slide","deprecated":null,"version":null,"openapi":"https://test.polltheroom.com/openapi.json post /api/v1/decks/{id}/steps/{index}/elements","href":"/api-reference/decks/put-text-a-shape-or-a-picture-on-a-slide"},{"title":"Take text, a shape or a picture off a slide","deprecated":null,"version":null,"openapi":"https://test.polltheroom.com/openapi.json delete /api/v1/decks/{id}/steps/{index}/elements/{kind}/{element}","href":"/api-reference/decks/take-text-a-shape-or-a-picture-off-a-slide"},{"title":"Change text, a shape or a picture","deprecated":null,"version":null,"openapi":"https://test.polltheroom.com/openapi.json patch /api/v1/decks/{id}/steps/{index}/elements/{kind}/{element}","href":"/api-reference/decks/change-text-a-shape-or-a-picture"},{"title":"Copy a step","deprecated":null,"version":null,"openapi":"https://test.polltheroom.com/openapi.json post /api/v1/decks/{id}/steps/{index}/duplicate","href":"/api-reference/decks/copy-a-step"},{"title":"Move a step","deprecated":null,"version":null,"openapi":"https://test.polltheroom.com/openapi.json post /api/v1/decks/{id}/steps/{index}/move","href":"/api-reference/decks/move-a-step"},{"title":"Screenshot a step","deprecated":null,"version":null,"openapi":"https://test.polltheroom.com/openapi.json get /api/v1/decks/{id}/steps/{index}/screenshot","href":"/api-reference/decks/screenshot-a-step"},{"title":"List the fonts","deprecated":null,"version":null,"openapi":"https://test.polltheroom.com/openapi.json get /api/v1/fonts","href":"/api-reference/decks/list-the-fonts"},{"title":"Attach the slides as a PDF","deprecated":null,"version":null,"openapi":"https://test.polltheroom.com/openapi.json put /api/v1/decks/{id}/source","href":"/api-reference/decks/attach-the-slides-as-a-pdf"}]},{"group":"rooms","pages":[{"title":"List rooms","deprecated":null,"version":null,"openapi":"https://test.polltheroom.com/openapi.json get /api/v1/rooms","href":"/api-reference/rooms/list-rooms"},{"title":"Start a room","deprecated":null,"version":null,"openapi":"https://test.polltheroom.com/openapi.json post /api/v1/rooms","href":"/api-reference/rooms/start-a-room"},{"title":"Drive a room","deprecated":null,"version":null,"openapi":"https://test.polltheroom.com/openapi.json post /api/v1/rooms/{code}/actions","href":"/api-reference/rooms/drive-a-room"},{"title":"Read the results","deprecated":null,"version":null,"openapi":"https://test.polltheroom.com/openapi.json get /api/v1/rooms/{code}/results","href":"/api-reference/rooms/read-the-results"},{"title":"Read every session's results","deprecated":null,"version":null,"openapi":"https://test.polltheroom.com/openapi.json get /api/v1/decks/{id}/results","href":"/api-reference/rooms/read-every-sessions-results"}]}]}]},"basePath":"","title":"Outline a deck - Poll the Room","buildId":"dpl_DTau1J5HqS9UTgVSDwGksstFWtPa","deploymentId":"dpl_DTau1J5HqS9UTgVSDwGksstFWtPa","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-5FCzAcfS.js","utils-SLtAG4EZ.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-2DZi8ZMu.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-D7J3nkzE.js","snippetPresets-D0Alv0AH.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BI4qNJ2c.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BD3uyr8j.js","shallow-D8iEBr5z.js","getApiPlaygroundDisplay-CgNP4lzR.js","CodeSnippet-CX-QHuMs.js","CodeSnippets-VlXE-ZUf.js","Page-D9ithiIZ.js","getPastedJson-DYNQkZ1M.js","icon-CzacdwOi.js","MethodPill-2JVqoYKi.js","DuplicateIcon-_xVXs-U8.js","createIcon-BRHrweLo.js","DynamicMarkdown-mQG_iQiE.js","SectionHeading-DMpJzv8f.js","axios-vUo_bRtp.js","Markdown-5FGIym-8.js","clsx-D-TRO5q5.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CdrJecqK.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-CHlcWBLM.js"]}