<aside> ⚠️

Warning: the templating mode is available as an alpha feature.

This means that this feature and the API parameters may be deprecated with two weeks’ notice.

If you plan to use this endpoint in production, we ask that you warn Photoroom beforehand.

</aside>

<aside> 💬

With this early access to this feature, we ask you give us feedback within two weeks to enable us to build on it.

</aside>

Step 1: Create your template

  1. Go to https://app.photoroom.com/create.
  2. Start a design from an image or from a Photoroom template. For example, open or upload an image in the Design tab.
  3. Turn the design into a template to access the templating features

image.png

  1. You can then see “You are editing a Template” at the top of your editor, to confirm you are in templating mode.

image.png

  1. You can select any text layer, or add a text layer using “Add text” at the top. You can then make the text replaceable by switching the “Replaceable Text” on. Edit the Unique ID to give a unique name to your text layer. This ID is how you will refer to this text in the API to dynamically fill it.

image.png

  1. Apart from text, you can also make images replaceable programmatically. You can select any image layer, or add an image layer using “Insert”. To make the image replaceable, switch “Replaceable Subject” on. Edit the Unique ID to give a unique name to your image layer. This ID is how you will refer to this image in the API to dynamically replace it.
  2. Make the template public to enable the API to access it: select “Public link” from the sharing settings. This means the template is public only to the people who know about this specific template ID. It enables the API to have access to your template.

image.png

  1. For now, it's necessary to get the template ID from the URL (from after the last /, to before the first ?). We're working on an easier way to get it.

image.png

<aside> ✨

You now have a template with replaceable layers each identified by a unique ID. The template is publicly shared so that the API can access it.

</aside>

Step 2: Use the template demo tool (optional)