How to render images via the API

The fastest way to your first API render: open your template's Playground (via Quick Connect) and switch to the REST API tab — your exact render as a copy-paste request:

The anatomy of a render call#

curl -X POST "https://api.orshot.com/v1/studio/render" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "templateId": "12307",
    "modifications": {
      "headline": "INBOX ZERO IS A MYTH"
    },
    "response": { "type": "url", "format": "png" }
  }'

• templateId + API key — where to find both
• modifications — your template's dynamic parameters
• response — url, base64 or binary; formats png, jpg, webp, avif, pdf (plus mp4, webm, gif for video templates)

The response contains a URL to your rendered image — cached for speed on repeat calls.

Related#