Configure FlashDocs Documents Via API
Configure Custom Document Templates and Libraries via the API
You can create, view, and edit your organization’s FlashDocs templates & libraries at: https://dash.flashdocs.ai
This tutorial will show you how to do the following:
Authenticate
Upload a Google Slides presentation and convert it into a FlashDocs Library
View your uploaded document
Crash Course on How FlashDocs Works
Before continuing, make sure you know:
-
The difference between a Template and a Library in FlashDocs
-
A FlashDocs template is a series of slides with placeholders. When a template deck is generated, it uses the all of the slides in the specified order and customizes the placeholder values to the given context.
-
A FlashDocs library is a large set of slides. When a custom deck is created, specific slides from the library are selected based on the context of the deck. The placeholders in these slides are customized to the given context.
-
-
A general idea about placeholders in a FlashDocs document and how FlashDocs uses them to create custom presentations.
Crash Course
Learn the basics of how FlashDocs works in 60 seconds.
Set-Up
Upload Documents
FlashDocs supports Google Slides and PowerPoint - in this example, we create a FlashDocs Library from a Google Slides document.
After uploading a presentation, you can create endless decks from it using the launch endpoint.
Intuition
FlashDocs generates decks by choosing relevant slides from the master deck and then replacing all of the text, images, and charts in the slide depending on the user’s prompt + context.
Deck Creation
FlashDocs generates decks by choosing relevant slides from the master deck and then replacing all of the text, images, and charts in the slide depending on the user’s prompt + context.
Standardization
FlashDocs standardizes and processes the slides to make them usable for programmatic creation.
-
- Changes all text to placeholders - If
reset_test_boxes=true
-
- Identifies image placeholders (logos)
-
- and more…
For best performance, include lots of slides in the library so the system can find a relevant layout for each slide generation.
Upload Endpoints
Example Usage (Google)
Feel free to use your own Google Document Link. For demonstration purposes, we created a sample library with a handful of slides: Google Slide Sample Library [Original]. The document is public, so feel free to check it out.
Here is a duplicated result of the deck after the text boxes are reset: View Only Google Slide Sample Library [After Upload]
Note that in the output deck (result after calling endpoint), all of the text is transformed into placeholders (with square brackets around categories of text). This happens because the example includes reset_text_boxes=true, which identifies all text elements and transforms them into FlashDocs text placeholders.
Using the upload_google_presentation_as_library
function defined in the “Create Google Slides Library” section:
Error Handling
For Google Slides presentations, our service worker must be able to access and edit the document. You might be asked to manually share the document with flashy@flashdocs.ai, flashy1@flashdocs.ai, flashy2@flashdocs.ai, and flashy2@flashdocs.ai
Contact adam@flashdocs.ai if you have any unexpected difficulties.
View and Edit Your Uploaded Document
After successfully uploading your document, you may want to verify its full details, including the placeholders created within each slide. The FlashDocs API offers a route to fetch the complete document object, where you can specify which parts (slides, questions, knowledge base items, or embeddings) you want included in the response.
User Interface For FlashDocs Document Updates
You can create, view, and edit your organization’s FlashDocs templates & libraries at: https://dash.flashdocs.ai