> 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/models.md).

# Models

## The Error object

```json
{"openapi":"3.1.0","info":{"title":"PlusAI REST API","version":"v0"},"components":{"schemas":{"Error":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}}}}
```

## The UploadError object

```json
{"openapi":"3.1.0","info":{"title":"PlusAI REST API","version":"v0"},"components":{"schemas":{"UploadError":{"type":"object","description":"Error envelope returned by the file-upload endpoint.","properties":{"error":{"type":"string"}},"required":["error"]}}}}
```

## The PaymentRequiredError object

```json
{"openapi":"3.1.0","info":{"title":"PlusAI REST API","version":"v0"},"components":{"schemas":{"PaymentRequiredError":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"]}}}}
```

## The CreateAgentSessionRequest object

```json
{"openapi":"3.1.0","info":{"title":"PlusAI REST API","version":"v0"},"components":{"schemas":{"CreateAgentSessionRequest":{"type":"object","properties":{"prompt":{"type":"string","description":"The initial instruction for the agent."},"pptxFileId":{"type":"string","description":"ID of an existing PowerPoint file (uploaded via the files API) to\nseed the session with. Must reference a `.pptx` file (legacy\n`.ppt` files aren't supported).\n"},"language":{"type":"string","description":"Target language. Defaults to `auto`.","default":"auto"},"attachments":{"type":"array","description":"Files to attach to the initial message.","items":{"type":"object","properties":{"fileId":{"type":"string"}},"required":["fileId"]}},"callbackUrl":{"type":"string","format":"uri","description":"HTTPS URL invoked when the session changes state. Must be a public\nHTTPS address (no localhost/private IPs).\n"},"model":{"type":"string","description":"The model to use.","enum":["claude-fable-5","claude-opus-5-5","claude-opus-5","claude-opus-4-8","claude-opus-4-7","claude-opus-4-6","claude-sonnet-5-5","claude-sonnet-5","claude-sonnet-4-6","claude-haiku-4-5","gpt-5.4","gpt-5.4-nano","gpt-5.4-mini","gpt-5.4-pro","gpt-5.5","gpt-5.5-pro","gpt-5.6-sol","gpt-5.6-terra","gpt-5.6-luna","@cf/moonshotai/kimi-k2.7-code"]}},"required":["prompt"]}}}}
```

## The CreateAgentSessionResponse object

```json
{"openapi":"3.1.0","info":{"title":"PlusAI REST API","version":"v0"},"components":{"schemas":{"CreateAgentSessionResponse":{"type":"object","properties":{"sessionId":{"type":"string"},"pollingUrl":{"type":"string","format":"uri","description":"URL to poll for session state."}},"required":["sessionId","pollingUrl"]}}}}
```

## The SendAgentSessionMessageRequest object

```json
{"openapi":"3.1.0","info":{"title":"PlusAI REST API","version":"v0"},"components":{"schemas":{"SendAgentSessionMessageRequest":{"type":"object","properties":{"prompt":{"type":"string","description":"The follow-up instruction for the agent."},"attachments":{"type":"array","description":"Files to attach to the message, as for `POST /r/v0/agent/sessions`.\n","items":{"type":"object","properties":{"fileId":{"type":"string"}},"required":["fileId"]}},"callbackUrl":{"type":"string","format":"uri","description":"HTTPS URL invoked when this turn ends, replacing the session's\ncallback URL. Must be a public HTTPS address (no localhost/private\nIPs).\n"},"expectedTurn":{"type":"integer","minimum":0,"description":"The session's `turn` the caller last saw. The message is refused\nwith `409 CONVERSATION_ADVANCED` if the session has moved on.\n"}},"required":["prompt"]}}}}
```

## The SendAgentSessionMessageResponse object

```json
{"openapi":"3.1.0","info":{"title":"PlusAI REST API","version":"v0"},"components":{"schemas":{"SendAgentSessionMessageResponse":{"type":"object","properties":{"sessionId":{"type":"string"},"turn":{"type":"integer","description":"The turn this message started. Poll until the session reports it."},"pollingUrl":{"type":"string","format":"uri","description":"URL to poll for session state (the same for every turn)."}},"required":["sessionId","turn","pollingUrl"]}}}}
```

## The AgentSessionRefusal object

```json
{"openapi":"3.1.0","info":{"title":"PlusAI REST API","version":"v0"},"components":{"schemas":{"AgentSessionRefusal":{"type":"object","description":"Why the session didn't accept the message. Nothing was changed.","properties":{"code":{"type":"string","enum":["AGENT_BUSY","CONVERSATION_ADVANCED","SESSION_NOT_CONTINUABLE","CONTEXT_OVERFLOW","INSUFFICIENT_AGENT_CREDITS","NOT_ORG_MEMBER","PRESENTATION_EDIT_FORBIDDEN","SESSION_EXPIRED","INVALID_ATTACHMENT_KEY","ATTACHMENT_FAILED","PDF_PAGE_LIMIT","ORG_ACCESS_UNVERIFIED","TURN_START_FAILED"]},"message":{"type":"string"},"turn":{"type":"integer","description":"The session's current turn."},"reason":{"type":"string","description":"For `SESSION_NOT_CONTINUABLE` and `SESSION_EXPIRED`, why the\nconversation can't continue (e.g. `agent`, `model_retired`, `age`, `turns`).\n"},"staleAt":{"type":["string","null"],"format":"date-time","description":"`AGENT_BUSY` only: when the running turn counts as stalled, after\nwhich a new message replaces it.\n"},"interruptUrl":{"type":"string","format":"uri","description":"`AGENT_BUSY` only: the URL that stops the running turn."}},"required":["code","message"]}}}}
```

## The InterruptAgentSessionRequest object

```json
{"openapi":"3.1.0","info":{"title":"PlusAI REST API","version":"v0"},"components":{"schemas":{"InterruptAgentSessionRequest":{"type":"object","properties":{"expectedTurn":{"type":"integer","minimum":0,"description":"Stop only this turn. Without it, whichever turn is in progress is\nstopped.\n"}}}}}}
```

## The InterruptAgentSessionResponse object

```json
{"openapi":"3.1.0","info":{"title":"PlusAI REST API","version":"v0"},"components":{"schemas":{"InterruptAgentSessionResponse":{"type":"object","properties":{"sessionId":{"type":"string"},"turn":{"type":"integer","description":"The turn that was stopped."},"status":{"type":"string","enum":["INTERRUPTED"]}},"required":["sessionId","turn","status"]}}}}
```

## The AgentSessionNotActive object

```json
{"openapi":"3.1.0","info":{"title":"PlusAI REST API","version":"v0"},"components":{"schemas":{"AgentSessionNotActive":{"type":"object","properties":{"code":{"type":"string","enum":["NOT_ACTIVE"]},"message":{"type":"string"},"turn":{"type":"integer","description":"The session's current turn."},"status":{"type":"string","description":"The session's status."}},"required":["code","message","turn","status"]}}}}
```

## The AgentSession object

```json
{"openapi":"3.1.0","info":{"title":"PlusAI REST API","version":"v0"},"components":{"schemas":{"AgentSession":{"type":"object","properties":{"sessionId":{"type":"string"},"status":{"type":"string","description":"The status of the current turn: `READY`, `RUNNING` and\n`PENDING_TOOL_CALLS` are in progress; `IDLE` means the turn\nfinished and the session is waiting for the next message.\n","enum":["READY","IDLE","RUNNING","PENDING_TOOL_CALLS","DONE","INTERRUPTED","FAILED"]},"turn":{"type":"integer","minimum":0,"description":"The conversation turn the session is on: 0 for the prompt it was\ncreated with, then one more for each message posted to it.\n"},"lastAssistantMessage":{"type":["string","null"],"description":"The agent's latest reply in the current turn, once it has ended. Null for sessions not created through this API (e.g. the web app's or the PowerPoint add-in's chats)."},"statusMessage":{"type":["string","null"],"description":"A description of the current status, e.g. why the turn failed."},"stalled":{"type":"boolean","description":"The current turn can no longer finish (it never started, or stopped\nmaking progress). Stop polling it; posting a new message replaces\nthe stalled turn.\n"},"turnCreditsUsed":{"type":["number","null"],"description":"AI agent credits the current turn has used so far."},"turnPptxUrl":{"type":["string","null"],"format":"uri","description":"Download URL for the presentation as of the end of the current\nturn (populated once the turn is finished). `pptxUrl` is always the\nlatest version.\n"},"pdfUrl":{"type":["string","null"],"format":"uri","description":"Download URL for the generated PDF (populated when finished)."},"pptxUrl":{"type":["string","null"],"format":"uri","description":"Download URL for the generated PPTX (populated when finished)."},"thumbnailUrl":{"type":["string","null"],"format":"uri","description":"Download URL for a thumbnail image (populated when finished)."},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["sessionId","status","turn","stalled"]}}}}
```

## The UploadAccepted object

```json
{"openapi":"3.1.0","info":{"title":"PlusAI REST API","version":"v0"},"components":{"schemas":{"UploadAccepted":{"type":"object","properties":{"status":{"type":"string"},"uploadId":{"type":"string"},"message":{"type":"string"}},"required":["status","uploadId","message"]}}}}
```

## The FileListResponse object

```json
{"openapi":"3.1.0","info":{"title":"PlusAI REST API","version":"v0"},"components":{"schemas":{"FileListResponse":{"type":"object","properties":{"files":{"type":"array","items":{"$ref":"#/components/schemas/File"}},"nextCursor":{"type":["string","null"],"description":"Cursor for the next page, or null if there are no more files."}},"required":["files","nextCursor"]},"File":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":["string","null"]},"contentType":{"type":["string","null"]},"urn":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","urn"]}}}}
```

## The File object

```json
{"openapi":"3.1.0","info":{"title":"PlusAI REST API","version":"v0"},"components":{"schemas":{"File":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":["string","null"]},"contentType":{"type":["string","null"]},"urn":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","urn"]}}}}
```

## The CreatePresentationRequest object

```json
{"openapi":"3.1.0","info":{"title":"PlusAI REST API","version":"v0"},"components":{"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"]}}}}
```

## The CreatePresentationResponse object

```json
{"openapi":"3.1.0","info":{"title":"PlusAI REST API","version":"v0"},"components":{"schemas":{"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"]}}}}
```

## The Presentation object

```json
{"openapi":"3.1.0","info":{"title":"PlusAI REST API","version":"v0"},"components":{"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"]}}}}
```

## The User object

```json
{"openapi":"3.1.0","info":{"title":"PlusAI REST API","version":"v0"},"components":{"schemas":{"User":{"type":"object","properties":{"email":{"type":"string"},"name":{"type":["string","null"]}}}}}}
```


---

# 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/models.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.
