Skip to main content
POST
/
v3
/
generate
/
outline
Generate Outline Preview
curl --request POST \
  --url https://api.flashdocs.ai/v3/generate/outline \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data @- <<EOF
{
  "prompt": "In a few slides, describe the recent Innovations in Renewable Energy. Discuss the foundational problems and key papers. Include specific examples.",
  "source_document_id": "abc-def-ghi-jkl",
  "number_slides": 5,
  "audience_domain": "slack.com",
  "presentation_name": "Renewable Energy Innovations 2025",
  "outline": [
    {
      "content_instruction": "Introduce the topic of renewable energy and its importance.",
      "layout_instruction": "Title slide with a background image.",
      "markdown": "# Parallel Inference on GPUs for LLMs\n## **Data Parallelism**\n- Distributes batches of input data across GPUs.\n- **Benefits:** Increased throughput via simultaneous processing.\n## **Model Parallelism**\n- Splits the model's layers or components among GPUs.\n## **Pipeline Parallelism**\n- Overlaps different stages of inference, reducing idle time.\n- **Advantage:** Maximizes resource utilization.\n    - Use various layers of DNN see [here](https://developer.nvidia.com/blog).",
      "text_placeholder_manual_insertions": [
        {
          "placeholder": "[title]",
          "value": "Renewable Energy Innovations 2027"
        },
        {
          "placeholder": "[content]",
          "value": "Introduce the topic of renewable energy and its importance."
        }
      ],
      "image_placeholder_manual_insertions": [
        {
          "alt_text": "[top right]",
          "slide_index": 0,
          "url": "https://example.com/image.jpg"
        },
        {
          "alt_text": "[bottom left]",
          "slide_index": 1,
          "url": "https://example.com/image2.jpg"
        }
      ]
    }
  ],
  "number_option_per_slide": 5
}
EOF
[
  [
    {
      "slide_id": "abc123",
      "preview_link": "https://example.com/1.png",
      "content_description": "Title slide with image background"
    },
    {
      "slide_id": "def456",
      "preview_link": "https://example.com/2.png",
      "content_description": "Title slide, aligned to the left"
    }
  ],
  [
    {
      "slide_id": "ghi789",
      "preview_link": "https://example.com/3.png",
      "content_description": "Agenda with 3 items"
    },
    {
      "slide_id": "jkl012",
      "preview_link": "https://example.com/4.png",
      "content_description": "Mission statement"
    }
  ]
]

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json
​
prompt
string | null

The main (ideally information dense) instructions for how to create the slide(s). Can be ~400,000 characters.

Example:

"In a few slides, describe the recent Innovations in Renewable Energy. Discuss the foundational problems and key papers. Include specific examples."

​
source_document_id
string | null

Optional. The FlashDocs document ID of an existing source document to base the presentation content on. See the results from https://api.flashdocs.ai/v1/documents/base - the id key in the document object. If not provided, then any Library document in the organization is chosen.

Example:

"abc-def-ghi-jkl"

​
number_slides
integer | null

Optional. The desired number of slides in the generated presentation. If not provided, the system will automatically predict the number of slides from the prompt. Do not include if source_document_id is a template document.

Example:

5

​
audience_domain
string | null

Optional. Used to populate image placeholders with the audience-company-logo category. I.e. if this is a slide deck for an external audience, the audience_domain is the website of the company that the audience belongs to. If not provided, the system will predict. Must be valid domain name (ex: if you are making a deck to sell your product to the finance team at Intel, set this parameter to intel.com or https://intel.com)

Example:

"slack.com"

​
presentation_name
string | null

Optional. The desired filename name for the generated presentation deck. If not provided, the system will generate one based on the prompt.

Example:

"Renewable Energy Innovations 2025"

​
outline
OutlineItemFullContent · object[] | null

Optional. An array of outline instructions defining the content/layout for each slide.

​
number_option_per_slide
integer | null
default:5

Optional. Number of options per slide. Defaults to 1.

Response

Successfully generated outline preview.

​
slide_id
string
required

FlashDocs id of the slide. Can be found in the https://api.flashdocs.ai/v1/documents/{document_id}/full endpoint with include_slides=true in the id key for the slide object. Can only provide 1 of layout_instruction OR slide_id.

Example:

"slide_123"

​
preview_link
string
required

URL link to the preview of the slide.

Example:

"https://secure.flashdocs.com/xyz"

​
content_description
string | null

Optional. Description of the content of the slide.

Example:

"Renewable energy is the energy derived from natural processes that are replenished on a human timescale, such as sunlight, wind, rain, tides, waves, and geothermal heat, and biomass."