Documentation¶
Developer and agent documentation for Deckrun.
API Reference¶
The full REST API is documented from the OpenAPI spec.
- API Reference (Redoc) — coming soon
- OpenAPI spec (YAML) — machine-readable, for code generation and agent reasoning
How-To Guides¶
- Quickstart — first API call: markdown in, PDF out
- Agent Integration Guide — how an LLM agent should use Deckrun
Schemas¶
All public schemas are available at /schemas/ with descriptions, versions, and links to the canonical JSON files at /schemas/v1/.
Quick reference¶
| Endpoint | Description |
|---|---|
POST /generate |
Submit a generation job |
GET /jobs/{id} |
Poll job status |
GET /schema |
Get slide format schema (category=slide) |
GET /voices |
List available voices |
GET /voices/schema |
Get voice schema |
GET /providers |
List available output connectors |
GET /me |
Get account details |
GET /themes |
List available themes |