> ## Documentation Index
> Fetch the complete documentation index at: https://developer.demand-iq.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get a deck

> Returns the full deck including slides, FAQs, branding, and Q&A settings.



## OpenAPI

````yaml /openapi.json get /api/decks/{deckId}
openapi: 3.0.0
info:
  title: AI Presentations API
  version: 1.0.0
  description: >-
    REST API for AI Presentations — an AI-powered presentation platform with
    narrated slides, live Q&A, and deck management.


    **Authentication**: Most endpoints require a session cookie obtained from
    `POST /api/auth/login`. Presentation playback endpoints (`/api/qa`,
    `/api/narration/*`) also accept a `presentationId` for unauthenticated
    viewer access.
  contact:
    name: Demand IQ
    url: https://demand-iq.com
servers:
  - url: https://app.demand-iq.com
    description: Production
  - url: http://localhost:3000
    description: Local development
security: []
tags:
  - name: Decks
    description: Manage presentation decks
  - name: Slides
    description: Manage slides within a deck
  - name: FAQs
    description: Manage pre-built Q&A pairs
  - name: Branding
    description: Colors, logo, and call-to-action configuration
  - name: Q&A
    description: Live question answering and Q&A settings
  - name: Narration
    description: Text-to-speech synthesis
  - name: Presentations
    description: Create and manage personalized presentation instances
  - name: Generation
    description: AI-powered content generation from slide images
  - name: Images
    description: Image upload and management
  - name: Voices
    description: Available TTS voices
  - name: Utility
    description: Health check and diagnostics
  - name: Authentication
    description: Session-based login, logout, and identity
  - name: Company
    description: Organization contact info and knowledge base
  - name: Notifications
    description: Event subscriptions and delivery log
  - name: Contracts
    description: Contract template import and e-signature
  - name: Fonts
    description: Available Google Fonts for branding
  - name: Roof Measurements
    description: Request and track automated roof measurements
  - name: Actions
    description: Voice/text command detection for presentation control
  - name: Appointments
    description: Appointment scheduling for presentation viewers
  - name: Activity
    description: Recent presentation activity feed
  - name: Onboarding
    description: >-
      Per-user product onboarding milestones (ENG-641). Milestone endpoints are
      idempotent and are called by the app UI — they should not be treated as
      tenant-integration surface.
paths:
  /api/decks/{deckId}:
    get:
      tags:
        - Decks
      summary: Get a deck
      description: >-
        Returns the full deck including slides, FAQs, branding, and Q&A
        settings.
      parameters:
        - in: path
          name: deckId
          required: true
          schema:
            type: string
            format: uuid
          description: UUID of the deck
      responses:
        '200':
          description: Full deck data
          content:
            application/json:
              schema:
                type: object
                properties:
                  deck:
                    $ref: '#/components/schemas/Deck'
                  slides:
                    type: array
                    items:
                      $ref: '#/components/schemas/Slide'
                  faqs:
                    type: array
                    items:
                      $ref: '#/components/schemas/Faq'
                  branding:
                    $ref: '#/components/schemas/Branding'
                    nullable: true
                  qaSettings:
                    $ref: '#/components/schemas/QaSettings'
                    nullable: true
                  presentationsCount:
                    type: integer
                  generation:
                    $ref: '#/components/schemas/GenerationStatus'
                    nullable: true
                    description: >-
                      The latest unsettled generation job; null once it
                      completed or if the deck was never generated
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - sessionCookie: []
components:
  schemas:
    Deck:
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        description:
          type: string
          nullable: true
        type:
          type: string
          enum:
            - structured
            - image-based
        isActive:
          type: boolean
        metadata:
          type: object
          nullable: true
          properties:
            deckContext:
              type: string
              description: Background info used to guide AI narration generation
            voiceProvider:
              type: string
              enum:
                - elevenlabs
                - openai
        createdBy:
          type: string
          format: uuid
          nullable: true
          description: >-
            ID of the user who created the deck. Null for decks created before
            creator tracking was added.
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
      required:
        - id
        - name
        - type
        - isActive
        - createdAt
        - updatedAt
    Slide:
      type: object
      properties:
        id:
          type: string
          format: uuid
        slideId:
          type: string
        title:
          type: string
        bullets:
          type: array
          items:
            type: string
        narration_script:
          type: string
        slide_context:
          type: string
          nullable: true
        audio_url:
          type: string
          nullable: true
          description: S3 key for the slide audio file
        hero_img:
          type: string
          nullable: true
          description: S3 key for the slide image
        hero_img_thumb:
          type: string
          nullable: true
          description: >-
            Presigned URL for the 480px WebP thumbnail rendition of the hero
            image, sized for editor rails and library grid tiles. Falls back to
            the full image URL when no thumbnail exists (legacy uploads, SVGs,
            and images already at or below 480px). Present on deck read
            endpoints only; omitted from slide create/update responses.
        wordTimings:
          type: array
          items:
            $ref: '#/components/schemas/WordTiming'
          nullable: true
        orderIndex:
          type: integer
        slideType:
          type: string
          enum:
            - standard
            - product_pricing_v1
      required:
        - id
        - slideId
        - title
        - bullets
        - narration_script
        - orderIndex
        - slideType
    Faq:
      type: object
      properties:
        id:
          type: string
          format: uuid
        deckId:
          type: string
          format: uuid
        userQuestion:
          type: string
        cannedAnswer:
          type: string
        relatedSlideId:
          type: string
          nullable: true
        audioUrl:
          type: string
          nullable: true
          description: S3 key for the pre-generated answer audio
        wordTimings:
          type: array
          items:
            $ref: '#/components/schemas/WordTiming'
          nullable: true
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
      required:
        - id
        - deckId
        - userQuestion
        - cannedAnswer
        - createdAt
        - updatedAt
    Branding:
      type: object
      properties:
        id:
          type: string
          format: uuid
        deckId:
          type: string
          format: uuid
        name:
          type: string
          nullable: true
        logo:
          type: string
          nullable: true
          description: S3 key for logo image
        avatar:
          type: string
          nullable: true
          description: S3 key for rep avatar image
        chatName:
          type: string
          nullable: true
        chatGreeting:
          type: string
          nullable: true
        palette:
          $ref: '#/components/schemas/BrandingPalette'
        cta:
          $ref: '#/components/schemas/BrandingCta'
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
      required:
        - id
        - deckId
        - palette
        - cta
        - createdAt
        - updatedAt
    QaSettings:
      type: object
      properties:
        id:
          type: string
          format: uuid
        deckId:
          type: string
          format: uuid
        resumePromptText:
          type: string
          description: >-
            Spoken prompt asking if the viewer wants to continue the
            presentation
        resumeAudioUrl:
          type: string
          nullable: true
        resumeVoiceId:
          type: string
          nullable: true
        transitionPromptText:
          type: string
          description: Spoken bridge from Q&A back into the presentation
        transitionAudioUrl:
          type: string
          nullable: true
        transitionVoiceId:
          type: string
          nullable: true
      required:
        - id
        - deckId
        - resumePromptText
        - transitionPromptText
    GenerationStatus:
      type: object
      description: >-
        A deck generation job. The single-job endpoint (`GET
        /api/decks/{deckId}/generate/status`) adds the row counts and
        timestamps; the deck list and the per-organization poll carry only the
        fields common to both.
      properties:
        jobId:
          type: string
          format: uuid
        status:
          type: string
          enum:
            - pending
            - processing
            - completed
            - failed
        currentSlide:
          type: integer
          nullable: true
          description: >-
            The slide that most recently STARTED processing; completed work is
            currentSlide − 1
        totalSlides:
          type: integer
          nullable: true
          description: 0 until the job flips to processing
        progress:
          type: integer
          description: 0-100, derived from completed slides / totalSlides; 100 once settled
        error:
          type: string
          nullable: true
        slidesCreated:
          type: integer
          description: >-
            Slide rows that exist for the deck right now. This is the signal to
            refresh on: currentSlide marks a slide's start, and the row lands a
            full slide's work later. Single-job endpoint only.
        faqsCreated:
          type: integer
          description: >-
            FAQ rows that exist right now. The job tracks no FAQ state; they are
            written in one batch after the last slide. Single-job endpoint only.
        createdAt:
          type: string
          format: date-time
          description: Single-job endpoint only
        completedAt:
          type: string
          format: date-time
          nullable: true
          description: Single-job endpoint only
      required:
        - jobId
        - status
        - currentSlide
        - totalSlides
        - progress
    Error:
      type: object
      properties:
        error:
          type: string
      required:
        - error
    WordTiming:
      type: object
      properties:
        word:
          type: string
        startTime:
          type: number
          description: Start time in milliseconds
        endTime:
          type: number
          description: End time in milliseconds
      required:
        - word
        - startTime
        - endTime
    BrandingPalette:
      type: object
      properties:
        primary:
          type: string
          example: '#1a73e8'
        primaryLight:
          type: string
          example: '#4a9af5'
        accent:
          type: string
          example: '#fbbc04'
        neutral:
          type: string
          example: '#5f6368'
        text:
          type: string
          example: '#202124'
        userMessage:
          type: string
          nullable: true
          description: >-
            Background color for homeowner chat message bubbles. Falls back to
            primary color if not set.
          example: '#1a73e8'
        assistantMessage:
          type: string
          nullable: true
          description: Background color for AI assistant chat message bubbles.
          example: '#f1f3f4'
      required:
        - primary
        - primaryLight
        - accent
        - neutral
        - text
    BrandingCta:
      type: object
      properties:
        headline:
          type: string
        body:
          type: string
        buttonText:
          type: string
        buttonUrl:
          type: string
          format: uri
      required:
        - headline
        - body
        - buttonText
  securitySchemes:
    sessionCookie:
      type: apiKey
      in: cookie
      name: session
      description: Session cookie obtained from `POST /api/auth/login`.

````