> ## Documentation Index > Fetch the complete documentation index at: https://dev.polltheroom.com/llms.txt > Use this file to discover all available pages before exploring further. # Outline a deck > 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. ## OpenAPI ````yaml https://test.polltheroom.com/openapi.json get /api/v1/decks/{id}/outline openapi: 3.1.0 info: title: Poll the Room API version: '1' description: >- Live polls on a presenter's own slides. A presenter (or an agent acting for one) builds a deck; the audience joins on their phones with a six-digit code and never signs up. Keys are made under Settings › API and sent as `Authorization: Bearer ptr_…`. A key belongs to a team, carries scopes, and is rate limited per hour. Plans: Free may decks:read, decks:write, rooms:read, results:read at 60 requests an hour; Pro may decks:read, decks:write, rooms:read, rooms:start, results:read at 1000 requests an hour. The same verbs are MCP tools at https://test.polltheroom.com/api/mcp. The full reference is at https://test.polltheroom.com/llms-full.txt. servers: - url: https://test.polltheroom.com security: - apiKey: [] tags: - name: decks description: A deck is a document the editor and the API both read and write. - name: rooms description: A room is one live session of a deck. paths: /api/v1/decks/{id}/outline: get: tags: - decks 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. Needs the `decks:read` scope. operationId: get_outline parameters: - name: id in: path required: true schema: type: string minLength: 1 description: The deck's id responses: '200': description: OK content: application/json: schema: type: object properties: title: type: string steps: type: array items: type: object properties: index: type: integer minimum: -9007199254740991 maximum: 9007199254740991 kind: type: string enum: - join - slide - poll pageIndex: description: The page behind a slide; null is a blank slide anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' poll: description: A full-screen poll step's poll type: object properties: type: type: string prompt: type: string required: - type - prompt additionalProperties: false notes: type: string 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 kind: type: string enum: - overlay - text - shape - image index: type: integer minimum: -9007199254740991 maximum: 9007199254740991 rect: type: object properties: x: type: number minimum: 0 maximum: 1 'y': type: number minimum: 0 maximum: 1 w: type: number minimum: 0.02 maximum: 1 h: type: number minimum: 0.02 maximum: 1 required: - x - 'y' - w - h additionalProperties: false z: type: number description: Stacking order; higher is on top label: type: string description: >- The card's question, the text box's first words, the shape's kind, or image required: - id - kind - index - rect - z - label additionalProperties: false overlaps: type: array items: type: object properties: a: type: string b: type: string covered: type: number description: >- How much of the smaller element the other covers, 0 to 1 required: - a - b - covered additionalProperties: false description: >- Pairs of elements that sit on top of each other; empty when nothing overlaps warnings: type: array items: type: object properties: element: type: string description: The element it is about, "overlay 0", "text 1" with: description: The other element, for an overlap type: string message: type: string description: What is wrong and what to do required: - element - message additionalProperties: false description: >- What on this slide will not read well: a card too small to read, a card or text box over another required: - index - kind - elements - overlaps - warnings additionalProperties: false ready: type: boolean description: Every poll passes the readiness check, so a room can start problems: type: array items: type: object properties: step: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: The step's index; 0 is the join screen overlay: description: Which card on the slide, when it is one type: integer minimum: -9007199254740991 maximum: 9007199254740991 path: type: string description: The property, from the step message: type: string description: What to do, in the editor's words required: - step - path - message additionalProperties: false description: What stops it, by step; empty when ready 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 required: - title - steps - ready - problems - revision additionalProperties: false '401': description: No usable key. content: application/json: schema: $ref: '#/components/schemas/Error' '403': description: The key lacks the scope, or the plan does not sell it. content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: Nothing by that id within this key's reach. content: application/json: schema: $ref: '#/components/schemas/Error' '429': description: Over the key's hourly limit. content: application/json: schema: $ref: '#/components/schemas/Error' components: schemas: Error: type: object properties: error: type: string description: What went wrong, in a sentence fix: description: What to do about it, when we can tell type: string required: - error additionalProperties: false securitySchemes: 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. ````