Knowledge base

Image rendering & API

Robolly offers an easy-to-use API that you can use to programmatically render images and PDFs from your templates. The Robolly image-generating API is very simple to work with, yet extremely flexible. For example, you can use the API to set up dynamic open graph images, personalized welcome email images, customized wrap-up videos and so much more.

In this section, you can read frequently asked questions about rendering images and working with the API. For more technical details, check the API reference.

What file types are supported?

Robolly supports all standard formats and more. You can render JPGs, PNGs, WebPs, PDFs (including multipage PDFs), and MP4s.

Is it possible to adjust the output size/resolution when rendering images via API?

Yes! You can control the rendered image size with the scale parameter (min 0.1, max 3). So, if you have a template with size 1000x1000, you can get 2000x2000 by adding "scale=2" into the render link. Similarly get 500x500 with "scale=0.5".

Is it possible to force a download of the rendered image via API?

Yes! Use dl parameter in your render URL. If dl is present, it indicates the file should be downloaded when opening the render link in the browser. Example:

https://api.robolly.com/templates/123/render?dl&text=something

What parameters can I use in the render URL?

Besides element names, there are 3 query parameters you can use:

  • sig – request signature
  • scale – min 0.1, max 3
  • dl – if present, it indicates the file should be downloaded when opening the render link in the browser
  • q – quality of the rendered image.

Read more in the image rendering API reference.

Can I render multiple-page PDFs?

Yes, you can create and automatically generate multi-page PDFs with Robolly. To configure your PDF, navigate to the Multi PDFs section of your Dashboard.