Render API

Create a Mockup Render

Returns an image URL of the selected mockup template and provided design asset.

POSThttps://app.dynamicmockups.com/api/v1/renders

Authorization

apiKeyAuth

Header parameters

Body

application/json

mockup_uuid*string

The UUID of the mockup template.

Example: "754a46c5-7693-43a1-9cd4-aedabd273f57"

export_labelstring

A label for the exported image.

Example: "MY_FIRST_IMAGE_01"

export_optionsobject

smart_objects*array of object

List of smart objects inside a chosen mockup.

Response

200400401

Image successfully rendered.

Body

application/json

dataobject

successboolean

Indicates if the render API call was successful.

Example: true

messagestring

A message about the render api.

Example: ""

Request

JavaScriptCurlPython

const response = await fetch('https://app.dynamicmockups.com/api/v1/renders', {
    method: 'POST',
    headers: {
      "Accept": "application/json",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "mockup_uuid": "754a46c5-7693-43a1-9cd4-aedabd273f57",
      "smart_objects": [
        {
          "uuid": "0ff99239-c91a-47f8-86e6-61229ff93626"
        }
      ]
    }),
});
const data = await response.json();

Response

200

{
  "data": {
    "export_label": "MY_FIRST_IMAGE_01",
    "export_path": "https://app-dynamicmockups-psd-engine-production.s3.eu-central-1.amazonaws.com/variation-exports/ae1dd925-4783-4ccf-995b-1c7d8b23ae2a_2c9a6af3-45ca-4991-bc8b-5be37790c647.jpg"
  },
  "success": true,
  "message": ""
}

export_label

When defining this optional parameter in your request, the same value will be returned in the response.

This parameter is used to help recognize the request you sent with the label.

export_options.image_format

By default, we return a .png rendered image.

But sometimes, for example, you want to get a more optimized image for the web.

By providing some of the following values: jpg, png, webp you can control what image format you want from our API.

export_options.image_size

Same as image_format, you can tell our API if you need an image of a specific size.

We will return high image resolution, but sometimes you need smaller ones.

Provide export_options.image_size = 720 to get the image with 720px width.

The provided value will define image width and height will auto-scale.

smart_objects.asset.url

The provided URL image will be rendered inside a chosen smart object UUID.

The image must be one of the following extensions: jpg, jpeg, png, webp, gif

Make sure that the provided URL is publicly available since our API needs to download it and use it for render purposes.

This is especially important when providing links from Dropbox, Google Drive, and similar tools, make sure you provide the right URL with public permissions.

If not available or does not have permission to download, the API call will result in an error.

smart_objects.color

This optional field will paint the whole smart object with the provided color value.

You can provide two different value types:

• hexadecimal value, example: #AA411B

• or color names from this link

Left image without color - Right image with color

smart_objects.asset.fit

In our web application editor, you can turn on Print Area and place the asset position and size. Each of your uploaded assets using Render API will inherit this setting.

You can optionally change print area fit mode by selecting one of these: stretch, contain, cover

If you do not provide fit mode using Render API, we will inherit your setup in the web application and the asset will be used in the selected fit mode, size, and position.

smart_objects.asset.position

You can optionally change the position of your asset using Render API.

Set position.top and position.left to tweak your asset position if necessary.

If you do not provide a position using Render API, we will inherit your setup from the editor in the web application.

We highly recommend placing the print area in the web application editor. In that case, any assets provided to Render API will be automatically placed inside that print area box without providing any position values.

smart_objects.asset.size

You can optionally change the size of your asset using API.

Set size.width and size.height to tweak your asset size if necessary.

Same as the asset.position, asset.size will be inherited from the editor in the web application if not provided.

This way, we allow you to visually set your asset position and size in our web application editor so you don't have to provide any asset positions and sizes using Render API.