> For the complete documentation index, see [llms.txt](https://guide.plusai.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://guide.plusai.com/apis-for-presentations/api-reference/presentations.md).

# Presentations

Generate presentations from a text prompt.

## POST /r/v0/presentation

> Generate a presentation from a prompt

```json
{"openapi":"3.1.0","info":{"title":"PlusAI REST API","version":"v0"},"tags":[{"name":"Presentations","description":"Generate presentations from a text prompt."}],"servers":[{"url":"https://api.plusdocs.com","description":"Production"}],"security":[{"apiKey":[]}],"components":{"securitySchemes":{"apiKey":{"type":"http","scheme":"bearer","description":"API key issued for your Plus organization, sent as a bearer token."}},"schemas":{"CreatePresentationRequest":{"type":"object","properties":{"prompt":{"type":"string"},"language":{"type":"string","default":"en"},"numberOfSlides":{"type":"integer"},"textHandling":{"type":"string","description":"How existing text content should be handled."},"includeUserTips":{"type":"boolean","default":false},"templateId":{"type":"string"},"generationMode":{"type":"string","default":"SLIDES","enum":["SLIDES","IMAGES"],"description":"Generation pipeline to use. `SLIDES` (default) produces a\ntext-based deck; `IMAGES` produces an image-per-slide deck.\n"},"attachments":{"type":"array","description":"Files to use as content sources for the deck. In `IMAGES` mode,\nPNG/JPEG attachments additionally steer the generated images as\nstyle references. Each `fileId` comes from\n`PUT /r/v0/files/upload`.\n","items":{"type":"object","properties":{"fileId":{"type":"string"}},"required":["fileId"]}},"design":{"type":"string","description":"`IMAGES` mode only. Free-form deck-wide design direction (as\nproduced by the writer agent), threaded into every per-slide image\nprompt so the deck stays visually cohesive. Rejected with `400` in\n`SLIDES` mode.\n"},"slides":{"type":"array","description":"`IMAGES` mode only. A caller-supplied outline, matching what the\nweb app's writer agent produces. When provided, the deck is\ngenerated from these slides rather than from the prompt alone.\nMust contain between 1 and 40 slides; rejected with `400` in\n`SLIDES` mode.\n","items":{"type":"object","properties":{"title":{"type":"string","description":"The slide title. Required and must be non-empty."},"keyPoints":{"type":"array","description":"The main ideas this slide must communicate.","items":{"type":"string"}},"supportingInformation":{"type":"string","description":"Supporting data, facts, quotes, or context the slide can\ndraw on.\n"},"referenceFileIds":{"type":"array","description":"Reference image file IDs targeted at this slide. Each id must\nalso appear in `attachments` (from `PUT /r/v0/files/upload`).\n","items":{"type":"string"}}},"required":["title"]}}},"required":["prompt"]},"CreatePresentationResponse":{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string"},"generationMode":{"type":"string","enum":["SLIDES","IMAGES"],"description":"The generation mode the presentation was created with."},"pollingUrl":{"type":"string","format":"uri"}},"required":["id","status","pollingUrl"]},"Error":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}},"responses":{"BadRequest":{"description":"The request was malformed or missing required fields.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"Unauthorized":{"description":"Missing or invalid API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"InternalServerError":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"paths":{"/r/v0/presentation":{"post":{"operationId":"createPresentation","tags":["Presentations"],"summary":"Generate a presentation from a prompt","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePresentationRequest"}}}},"responses":{"201":{"description":"Presentation generation started.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePresentationResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"429":{"description":"Concurrent presentation processing limit exceeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}}
```

## GET /r/v0/presentation/{presentationId}

> Get a presentation

```json
{"openapi":"3.1.0","info":{"title":"PlusAI REST API","version":"v0"},"tags":[{"name":"Presentations","description":"Generate presentations from a text prompt."}],"servers":[{"url":"https://api.plusdocs.com","description":"Production"}],"security":[{"apiKey":[]}],"components":{"securitySchemes":{"apiKey":{"type":"http","scheme":"bearer","description":"API key issued for your Plus organization, sent as a bearer token."}},"schemas":{"Presentation":{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string"},"generationMode":{"type":"string","enum":["SLIDES","IMAGES"],"description":"The generation mode the presentation was created with."},"language":{"type":["string","null"]},"slides":{"type":["array","null"],"items":{"type":"string"},"description":"Slide titles."},"images":{"type":["array","null"],"items":{"type":["string","null"],"format":"uri"},"description":"Per-slide generated image URLs, in slide order. Only populated for\nimage-mode decks (`null` otherwise). The URLs resolve once the\npresentation reaches `COMPLETED`.\n"},"url":{"type":["string","null"],"format":"uri","description":"URL to the full generated PPTX."},"thumbnailUrl":{"type":["string","null"],"format":"uri","description":"URL to a thumbnail image of the presentation."},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","status"]},"Error":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}},"responses":{"BadRequest":{"description":"The request was malformed or missing required fields.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"Unauthorized":{"description":"Missing or invalid API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"paths":{"/r/v0/presentation/{presentationId}":{"get":{"operationId":"getPresentation","tags":["Presentations"],"summary":"Get a presentation","parameters":[{"name":"presentationId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The presentation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Presentation"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"description":"Presentation not found."}}}}}}
```

## List presentations

> Returns up to 50 of the presentations created via this API.

```json
{"openapi":"3.1.0","info":{"title":"PlusAI REST API","version":"v0"},"tags":[{"name":"Presentations","description":"Generate presentations from a text prompt."}],"servers":[{"url":"https://api.plusdocs.com","description":"Production"}],"security":[{"apiKey":[]}],"components":{"securitySchemes":{"apiKey":{"type":"http","scheme":"bearer","description":"API key issued for your Plus organization, sent as a bearer token."}},"schemas":{"Presentation":{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string"},"generationMode":{"type":"string","enum":["SLIDES","IMAGES"],"description":"The generation mode the presentation was created with."},"language":{"type":["string","null"]},"slides":{"type":["array","null"],"items":{"type":"string"},"description":"Slide titles."},"images":{"type":["array","null"],"items":{"type":["string","null"],"format":"uri"},"description":"Per-slide generated image URLs, in slide order. Only populated for\nimage-mode decks (`null` otherwise). The URLs resolve once the\npresentation reaches `COMPLETED`.\n"},"url":{"type":["string","null"],"format":"uri","description":"URL to the full generated PPTX."},"thumbnailUrl":{"type":["string","null"],"format":"uri","description":"URL to a thumbnail image of the presentation."},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","status"]},"Error":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}},"responses":{"BadRequest":{"description":"The request was malformed or missing required fields.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"Unauthorized":{"description":"Missing or invalid API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"paths":{"/r/v0/presentations":{"get":{"operationId":"listPresentations","tags":["Presentations"],"summary":"List presentations","description":"Returns up to 50 of the presentations created via this API.","responses":{"200":{"description":"A list of presentations.","content":{"application/json":{"schema":{"type":"object","properties":{"presentations":{"type":"array","items":{"$ref":"#/components/schemas/Presentation"}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://guide.plusai.com/apis-for-presentations/api-reference/presentations.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
