Documentation¶

Developer and agent documentation for Deckrun.

Deckrun is an async rendering API: submit structured markdown, receive finished artifacts (PDF, video, audio) via polling or connectors.

API Reference¶

The full REST API is documented from the OpenAPI spec.

API Reference (Redoc) — interactive docs (launching shortly)
OpenAPI spec (YAML) — machine-readable, for code generation and agent reasoning

Getting Started¶

Quickstart — first API call: markdown in, PDF out
Agent Integration Guide — how an LLM agent should use Deckrun
Managing Themes via API — create themes, upload logos, and apply branding programmatically

Schemas¶

Deckrun is fully schema-driven. All public schemas are available at /schemas/ with descriptions and links to the canonical versioned JSON definitions at /schemas/v1/.

Quick reference¶

Most generation endpoints are asynchronous. Submit a job, then poll for completion or retrieve outputs via connectors.

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 /connectors`	List available output connectors
`GET /me`	Get account details
`GET /slide-themes`	List available themes