POST
/
v3
/
generate
/
outline
curl --request POST \
  --url https://api.flashdocs.ai/v3/generate/outline \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "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": 123
}'
[
  [
    {
      "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

Response

200
application/json

Successfully generated outline preview.

The response is of type OutlineItemOption · object[][].