Orshot Logo
OrshotDocs

Template ID

Learn about what is Template ID and what it means in Orshot API

Orshot's core functionality is to turn templates into renders using API

The core of it are templates, which are carefully and beautifully designed so you can render all ready and set designs easily

The templateId is a required parameter in the endpoint. It serves as the unique identifier of a particular template used for rendering. The identifier is provided in string format, ensuring that the correct template is applied for the rendering process.

Key Points

  • Type: String
  • Uniqueness: Each value must be unique to each template.
  • Usage: Identifies which template to use for rendering.

Example

const response = await Orshot.renderFromTemplate({
  templateId: "website-screenshot", 
  responseType: "url",
  responseFormat: "webp",
  modifications: {
    /* Template modifications here */
  },
});

On this page