ORorshot
Generation & Templates

Render from Studio Template

Changed on

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

  • Base URL
    https://api.orshot.com/v1
  • URL
    https://api.orshot.com/v1/studio/render
  • Auth
    HTTP bearer

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, outlined text, 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.

webhook_url, metadatastring

Async mode only. See Start an Async Render.

langstring

Language of the template's text, as a language tag such as el, ja, zh-Hant or tr. Leave it out to use the template language set in the Studio, if any. See Set the text language.

translatestring

No

Response

Successful response

object required

Changes

  • 477bdeb3e606Revision changes
    • info

      added the new optional request property

    • info

      added the new optional request property

  • c17e8ad4d502Revision changes
    • info

      added the new optional request property

    • info

      added the new optional request property