Renders

POST /v1/renders renders one template to an image or PDF.

# Request

bash

curl https://api.mostlyrender.com/v1/renders \
  -H "Authorization: Bearer mr_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "template": "tpl_abc",
    "modifications": { "title": "Hello" },
    "output": "png"
  }'

Field	Type	Notes
`template`	string	Required. The template id. (`templateId` is also accepted.)
`modifications`	object	Layer overrides, keyed by layer name. See Templates as parameters.
`output`	string	`png` (default), `jpeg`, `webp`, or `pdf`.
`async`	boolean	Queue the job and return `202` instead of rendering inline.
`webhookUrl`	string	Signed callback on completion (implies `async`). See Async & webhooks.

# Response

json

{
  "id": "rnd_abc123",
  "url": "https://img.mostlyrender.com/mostlyrender/renders/rnd_abc123.png",
  "output": "png"
}

The url is public and CDN-cached. Renders are also logged in the app under Usage.

# Output formats

png — lossless, transparency. The default.
jpeg / webp — smaller; good for photos.
pdf — vector, great for print-ready assets.

# SDK

python

out = mr.render("tpl_abc", modifications={"title": "Hello"}, output="pdf")
print(out["url"])

For many images in one call, see Batch. For <img>/OG embedding without an API key, see Signed render URLs.