List Document Configurations

Created At

Email of user (non FlashDocs) who created the document

Created By

Description

Format of the document google vs microsoft

ID of the corresponding Google Slides document

Google Document Id

item_id for each knowledge base item associated with document.

Knowledge Base Item Ids

Name

ID of the organization this document belongs to

Organization Id

Type of the document (template or library)

Updated At

DocumentMetaData

DocumentStatus

DocumentType

Format

Location

Message

Error Type

ValidationError

OAuth2PasswordBearer

Response List Documents V1 Documents Base Get

HTTPValidationError

Starter Kit

FlashDocs - API for presentation creation.

Introduction

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

Quickstart - Custom Deck Generation

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

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 (`[`, `]`).
        - `reset_text_boxes=true`: Resets all text to placeholders, converting all text boxes into placeholders regardless of existing formatting.

Create Google Slides FlashDocs Template/Library

Upload a PowerPoint (.ppt or .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

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.

API Documentation

FlashDocs Document Configuration

Generate

List Document Configurations

Authorizations

Query Parameters

Response