What is a template ID?
The template ID is the unique string that tells the API which template to render. One per Studio template.
Updated
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 a few places:
- Templates page: go to your workspace templates and copy the ID from the template card
- Studio: open the template, click its name in the toolbar and choose Copy ID
- 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. Studio template IDs are numbers, such as 12345. Render them with renderFromStudioTemplate, which calls POST /v1/studio/render:
const orshot = new Orshot("<ORSHOT_API_KEY>");
const response = await orshot.renderFromStudioTemplate({
templateId: 12345, // [!code highlight]
modifications: {
title: "Hello World",
},
response: { type: "url", format: "png" },
});Library templates use text IDs, such as open-graph-image-1. Render those
with renderFromTemplate instead. It does not accept Studio template IDs.
Was this page helpful?
Ready to automate?
Start rendering images, PDFs and videos from your templates in under 2 minutes. Free plan, no credit card.
Get your API key- Image, PDF and video generation via API
- Visual editor with AI and smart layouts
- Zapier, Make, MCP and 40+ integrations
- White-label embed for your own app
- 100 free credits a month, no credit card required