Generate a deck outline including content and layout instructions

Generate Text Outline Instructions

Optional. Instruction for the content of the slide.

Content Instruction

Optional. Instruction for the layout/design of the slide. Can only provide 1 of `layout_instruction` OR `slide_id`.

Layout Instruction

DeckContentInstruction

Location

Message

Error Type

ValidationError

GenerateOutlineRequest

OAuth2PasswordBearer

Response Generate Outline Instructions V3 Generate Outline Instructions Post

HTTPValidationError

FlashDocs API

FlashDocs provides a robust, easy-to-use API for generating Microsoft PowerPoints and Google Slides.

Introduction

In this page, we do a super quick demonstration of how to create a custom deck.

Quickstart - Custom Deck Generation

Explore the 3 ways you can create programmatically slide decks.

3 Ways To Create Slide Decks

In this page, we explore various configurations and ways to control your custom deck creation.

Custom Deck Generation Walkthrough

In this page, we do a walk through of how to configure your FlashDocs templates and libraries through the dashboard.

Configure FlashDocs Template/Library

Use our API to replace text, images, tables, and charts.

Tag Replacement

Learn how to create slides from Markdown input.

Markdown -> Slides Walkthrough

Learn how FlashDocs converts Markdown to slides in your custom templates.

Introduction To Markdown -> Slides

List Document Configurations

Upload a Google Slides link to create a **template** or **library** within your organization.
        
        - **Template**: Ideal for creating reusable slide formats.
        - **Library**: Suitable for comprehensive collections of slides.
        
        **Processing Time**: Depending on the number of slides, processing may take a few minutes (e.g., 50 slides may take approximately 3 minutes). If upload speed is a concern, please contact us to discuss optimization options.
        
        **Text Box Handling**:
        - `reset_text_boxes=false`: Automatically identifies and captures text placeholders enclosed in brackets (`[`, `]`).
        - `resize_text_boxes=false`: Resizes text boxes to fit the text (only increases heights, does not shrink).

Create Google Slides FlashDocs Template/Library

Upload a PowerPoint (`*.pptx`) file to create a **template** or **library** within your organization.

        **Document Types**:
        - **Template**: Ideal for creating reusable slide formats.
        - **Library**: Suitable for comprehensive collections of slides.

        **Processing Time**: Depending on the size of the presentation, processing may take a few minutes. If upload speed is a concern, please contact us to discuss optimization options.

Create PowerPoint FlashDocs Template/Library

Get Document Configuration Full Data

Update Document Configuration

Delete Document Configuration

Get Slide Configuration Metadata

Compute Markdown Mapping for Slide

Validate Text Placeholder Manual Insertion

The **Generate Deck** endpoint creates a slide deck based on user-defined parameters that specify its content and structure. Upon successful creation, the endpoint returns a link to the deck along with execution details. Unlike the POST `/v3/generate/deck/task` endpoint—which immediately returns a deck generation task for polling—this endpoint waits until the entire deck has been rendered before sending the response.

Generate Slide(s)

The **Deck Generation Task** endpoint initiates a deck creation process and returns a task ID for polling its status. This endpoint mirrors the functionality of the POST `/v3/generate/deck` endpoint, but it immediately returns a deck generation task for status polling rather than waiting for the deck to render completely.

Generate Slide(s) Via Task (Async)

Get the completed deck link and metadata given a task ID.
    Usage:
    1. Use the POST `/v3/generate/deck/task` endpoint to generate a task.
    2. Poll this GET `/v3/generate/deck/task/{task_id}` endpoint to check the status of the task.

    Responses:
    - *200 OK* : If the generated deck is completed. It provides the response including a link to the deck.
    - *202 Accepted* : The deck is still generating. Body is empty. Poll again in ~5 seconds.
    - *404 Not Found* : The task id is not found or not available for your account.
    - *422 Unprocessable Entity* : There is some error with the request.

Poll Deck Generation Task Status

Generate a deck outline with multiple layout options per slide, each including a preview image, slide ID, and content description for easy selection and customization.

API Documentation

FlashDocs Document Configuration

Generate

Generate Text Outline Instructions

Authorizations

Body

Response