Render API
Last updated
Was this helpful?
Last updated
Was this helpful?
Export OpenAPI specification for Render API
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.
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.
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.
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.
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
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.
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.
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.
You can optionally apply blending_mode to the smart object.
Supported blending mode list:
You can optionally apply adjustment_layers to the smart object.
Supported adjustment layer list:
contrast
-100
100
0
brightness
-150
150
0
opacity
0
100
100
saturation
-100
100
0
vibrance
-100
100
0
Adjustment layers will be reflected in the Render API(just like Asset position does).
We will inherit your setup from the web application's editor if you do not explicitly provide adjustment_layers using the Render API.
Set the Adjustments in the web application's editor to change the default values.
Left image without color - Right image with color
Returns an image URL of the selected mockup template and provided design asset.
/renders
The request must accept JSON responses.
application/jsonAPI key required for authentication.
YOUR_API_KEY_HEREThe UUID of the mockup template.
754a46c5-7693-43a1-9cd4-aedabd273f57A label for the exported image.
MY_FIRST_IMAGE_01List of smart objects inside a chosen mockup.