v1

latestOpenAPI 3.1.02026-08-0654098.0 KB

Generation & Templates

Render from Studio Template

Render any template you've designed in Orshot Studio by making a POST request — as an image, PDF, or video, at any size, and optionally publish it.

post/studio/render

Request body

templateIdnumber required

Your template's ID — shown on the template's page and in the playground.

modificationsobject

Your dynamic values, keyed by parameter ID. Multi-page templates prefix keys with the page, e.g. page2@title. You can also set style parameters to change layer styles at render time.

responseobject

What to render and how to return it (format, type, size, …). See below.

pdfOptionsobject

PDF-only output controls (document title, margins, DPI, color mode, page range). See Render as a PDF.

videoOptionsobject

Video-only output controls (fps, trim, audio, subtitles, page transitions). See Render as a video.

publishobject

Publish the render to connected social accounts. See Publish to social.

Response

Successful response

object required