What are modifications?

The modifications object is how you tell Orshot what content to put in your template. Each key is a parameter name you defined in Studio, and the value is the content you want to display.

How It Works#

When you design a template in Studio, you set elements as parameters with IDs like title, authorName, or productImage. When calling the API, you pass those IDs in the modifications object:

const response = await orshot.renderFromTemplate({
  templateId: "your-template-id",
  responseType: "url",
  responseFormat: "png",
  modifications: {
    title: "Quarterly Sales Report", // text element
    authorName: "Jane Smith", // text element
    authorPhoto: "https://example.com/jane.jpg", // image element
    backgroundColor: "#1a1a2e", // style override
  },
});

What You Can Modify#

• Text — Replace any text element's content
• Images — Pass a URL to swap image elements
• Styles — Override colors, fonts, sizes using Dynamic Parameters
• Videos — Pass a URL to replace video elements
• Spoken text — Replace the script of a generated voiceover marked as dynamic

For dynamic narration, turn on Set per render for the voiceover in Studio. Its parameter ID appears with the voiceText type and accepts the new script as a string.