Skip to main content
The Open Source API is served by the same deployment as the browser application. With the default Docker installation, use:

Authentication

All /api/v1/* routes except /api/v1/auth/* require HTTP Basic authentication when the admin account is configured. Send the same username and password as the web UI.
Keep credentials in environment variables or a secret manager rather than embedding them in source code.

Endpoint families

The endpoint navigation on this page contains the complete schemas for this release.

First request

A successful response includes presentation_id, path, and edit_path. Prepend the Presenton server root when a returned URL path is relative.

Synchronous or asynchronous

Use synchronous generation for small interactive requests where the client can keep the connection open. Use asynchronous generation for larger documents, longer decks, background jobs, or provider calls with variable latency; track the returned job through the status endpoint or a webhook.

Documents and output

Upload source documents before generation, then pass the returned paths in the files array. The generate endpoint supports pptx and pdf output and can also accept a slide-by-slide Markdown structure.

Complete API tutorial

Generate from a prompt, upload a source document, and understand the result.

API and MCP concepts

Choose between REST, asynchronous jobs, webhooks, and MCP.
Cloud API v3 examples are not interchangeable with Open Source API v1 examples. Keep self-hosted requests pointed at the Presenton instance you operate.