POST: Render from Studio Template

Learn how you can make a POST request to render from a custom template on Orshot

You can render content from a custom template that you've designed using Orshot Studio by making POST request to Orshot API

https://api.orshot.com/v1/studio/render

POST Request

await fetch("https://api.orshot.com/v1/studio/render", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    Authorization: "Bearer <ORSHOT_API_KEY>",
  },
  body: JSON.stringify({
    templateId: <TEMPLATE_ID>, 
    modifications: {
      canvasBackgroundColor: "#eff2fa",
      title: "Custom Title",
      imageUrl: "Custom Image URL"
    },
    response : {
      type: "base64",
      format: "png",
      scale: 1
    },
  }),
});

You can learn more about params:

templateId: Each Studio template has a unique templateId(integer) which you can see on Template's page or payground
modifications: Object structure of the dynamic modidifcations that you've set in the template
response/format
response/type

POST: Render from Studio Template

POST Request

On this page