Template ID

Every template in Orshot has a unique templateId. You pass this ID in your API requests to tell Orshot which template to render.

Where to Find Your Template ID#

You can find your template ID in two places:

1. Templates page — Go to your workspace templates and copy the ID from the template card
2. Template Playground — Open any template and the ID is shown at the top of the playground page

How It's Used#

The templateId is a required parameter in the render API. It's a string that uniquely identifies your template:

const orshot = new Orshot("<ORSHOT_API_KEY>");

const response = await orshot.renderFromTemplate({
  templateId: "your-template-id", // [!code highlight]
  responseType: "url",
  responseFormat: "png",
  modifications: {
    title: "Hello World",
  },
});