> 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`/PowerPoint file.\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-opus-4-8","claude-opus-4-7","claude-opus-4-6","claude-sonnet-4-6","claude-haiku-4-5","gpt-5.4","gpt-5.4-nano","gpt-5.4-mini","gpt-5.5"]}},"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 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","enum":["READY","IDLE","RUNNING","PENDING_TOOL_CALLS","DONE","INTERRUPTED","FAILED"]},"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"]}}}}
```

## 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"}},"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"},"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"},"language":{"type":["string","null"]},"slides":{"type":["array","null"],"items":{"type":"string"},"description":"Slide titles."},"url":{"type":["string","null"],"format":"uri","description":"URL to the full generated PPTX."},"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 dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

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

The question should be specific, self-contained, and written in natural language.
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.
