What is a render type?

The renderType tells the API what kind of output to produce from a library template. It is used in the library generation endpoints and in signed URL generation.

Available values:

Library templates render as images only. Use images.

Where It's Used#

Render type appears in the URL path for library generation endpoints:

https://api.orshot.com/v1/generate/images

And as a parameter when generating signed URLs:

const response = await orshot.generateSignedUrl({
  templateId: "open-graph-image-1",
  modifications: { title: "Hello" },
  renderType: "images", // [!code highlight]
  responseFormat: "png",
  expiresAt: 1744276943,
});