Presentations
Generated decks: plan, generate, edit slide images, rebuild.
List presentations
Beta — this operation may change on 30 days notice. See versioning.
Requires the module-ppt license feature. Without it the request is refused with 403 license_required — see plans and modules.
query Parameters
cursor^[A-Za-z0-9_-]+$limitoffsetppt_job_createdppt_job_idppt_job_statussort^-?[a-z0-9_]+$Headers
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
List presentations › Responses
Success
has_moreWhether more rows exist past this page.
next_cursorPass back as cursor for the next page. Null on the last page.
Generate a presentation
Beta — this operation may change on 30 days notice. See versioning.
Queues generation from a brief, a template and an outline, and returns the job. Generation runs in the background — poll the presentation to follow it.
Requires the module-ppt license feature. Without it the request is refused with 403 license_required — see plans and modules.
Headers
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
Generate a presentation › Request Body
templateIdbriefjobIdagentIdthreadIdGenerate a presentation › Responses
Success
Get a presentation
Beta — this operation may change on 30 days notice. See versioning.
Includes its current status and, once generation has finished, the deck to download.
Requires the module-ppt license feature. Without it the request is refused with 403 license_required — see plans and modules.
path Parameters
idHeaders
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
Get a presentation › Responses
Success
ppt_job_idppt_job_createdppt_job_updatedppt_job_created_byppt_job_statusppt_job_progressppt_job_titleppt_job_paramsppt_job_planppt_job_output_file_idppt_job_errorppt_job_metadataDelete a presentation
Beta — this operation may change on 30 days notice. See versioning.
Limited to presentations the caller owns. The generated deck is removed with it.
Requires the module-ppt license feature. Without it the request is refused with 403 license_required — see plans and modules.
path Parameters
idHeaders
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
Delete a presentation › Responses
Success. No content.
Duplicate a presentation
Beta — this operation may change on 30 days notice. See versioning.
Clones the brief, outline and content into a new presentation and copies the generated deck. The copy is independent — deleting either one never removes the other's file.
Requires the module-ppt license feature. Without it the request is refused with 403 license_required — see plans and modules.
path Parameters
idHeaders
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
Duplicate a presentation › Responses
Success
Regenerate an image
Beta — this operation may change on 30 days notice. See versioning.
Finds the best photo in the library for that slide and generates a fresh image seeded by it. Recorded as an override on the same terms as choosing one by hand.
Requires the module-ppt license feature. Without it the request is refused with 403 license_required — see plans and modules.
path Parameters
idHeaders
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
Regenerate an image › Request Body
slideIndexslotNameRegenerate an image › Responses
Success
Choose a slide image
Beta — this operation may change on 30 days notice. See versioning.
Records the choice as an override. A deck still generating picks it up as it assembles; a finished one needs a rebuild before the file reflects it.
Requires the module-ppt license feature. Without it the request is refused with 403 license_required — see plans and modules.
path Parameters
idHeaders
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
Choose a slide image › Request Body
slideIndexslotNamefileIdChoose a slide image › Responses
Success
Rebuild the deck
Beta — this operation may change on 30 days notice. See versioning.
Regenerates the file from the presentation's current content, including any image overrides.
Requires the module-ppt license feature. Without it the request is refused with 403 license_required — see plans and modules.
path Parameters
idHeaders
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
Rebuild the deck › Responses
Success
Rename a presentation
Beta — this operation may change on 30 days notice. See versioning.
Changes only the display name, which is also the download filename. The plan is untouched, so renaming never changes what a rebuild produces.
Requires the module-ppt license feature. Without it the request is refused with 403 license_required — see plans and modules.
path Parameters
idHeaders
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
Rename a presentation › Responses
Success
Save a draft
Beta — this operation may change on 30 days notice. See versioning.
Stores the brief, template and outline as a draft without queueing generation, so the work survives leaving the page and can be picked up again.
Requires the module-ppt license feature. Without it the request is refused with 403 license_required — see plans and modules.
Headers
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
Save a draft › Request Body
templateIdbriefjobIdplanagentIdthreadIdstepSave a draft › Responses
Success
Plan an outline
Beta — this operation may change on 30 days notice. See versioning.
Turns a brief and a template into a proposed outline, and saves it onto the draft so it is not lost. Nothing is generated yet — this is the step where the structure is reviewed and edited.
Requires the module-ppt license feature. Without it the request is refused with 403 license_required — see plans and modules.
Headers
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
Plan an outline › Request Body
templateIdjobIdagentIdPlan an outline › Responses
Success