Sign in
decks

Changed on
post/api/decks

Request

  • The document declares no server URL.
  • Auth: none declared

Request body

promptstring required

What the deck should be about

slideCountnumber
languagestring
templatestring
tone'default' | 'casual' | 'professional' | 'funny' | 'educational' | 'sales_pitch'
verbosity'concise' | 'standard' | 'text-heavy'
instructionsstring

Extra guidance for the generator

includeTitleSlideboolean
includeTableOfContentsboolean
webSearchboolean

Let the generator search the web

Example request

{
  "prompt": "The causes and consequences of the 1997 Asian financial crisis"
}

Response

idstring required
status'QUEUED' | 'GENERATING' | 'READY' | 'FAILED' required
promptstring required
titlestring nullable
slideCountnumber required
languagestring required
templatestring required
errorstring nullable
createdAtstring date-time required
completedAtstring date-time nullable
queueAheadnumber nullable
etaSecondsnumber nullable
queueAheadIsApproximateboolean nullable

True when the exact position is beyond the scan limit

hasPdfboolean required

A PDF render exists, so the deck can be previewed in-app

canEditboolean required

The generator can still act on this deck

editorUrlstring nullable

Where to point the editor frame. Null when no editor host is configured.

tonestring required
verbositystring required
scheduledForstring date-time nullable

Set when the deck is held until the owner's allowance frees up

attemptsnumber required

Attempts made so far

maxAttemptsnumber required

Attempts before the deck is given up on

progressPhase'starting' | 'outline' | 'layout' | 'slides' | 'assets' | 'finishing' nullable

Which stage of generation the deck is in

progressDonenumber nullable

Slides finished so far

progressTotalnumber nullable

The generator's own slide total, which may differ from slideCount

shareTokenstring nullable required

The deck share token, or null when it is not shared. Owner-only.

Changes