POST
/
v3
/
generate
/
outline
curl --request POST \
  --url https://api.flashdocs.ai/v3/generate/outline \
  --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.",
  "number_slides": 5
}'
[
  {
    "content_instruction": "Introduce the topic of renewable energy and its importance.",
    "layout_instruction": "Title slide with a background image.",
    "slide_id": "slide_123"
  }
]

Body

application/json
​
prompt
string
required

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."

​
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.

Example:

5

Response

200
application/json
Successful Response
​
content_instruction
string | null

Optional. Instruction for the content of the slide.

Example:

"Introduce the topic of renewable energy and its importance."

​
layout_instruction
string | null

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

Example:

"Title slide with a background image."

​
slide_id
string | null

Optional. 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"

Poll Deck Generation Task Status