Batch Render Mockups API

Render Multiple Mockups

post

Returns an array of image URLs for multiple mockup templates with provided design assets in a single batch request. Export options specified at the root level apply to all renders.

Authorizations

apiKeyAuth

x-api-keystringRequired

API key required for authentication.

Header parameters

Acceptstring · enumRequired

The request must accept JSON responses.

Possible values:

x-api-keystringRequired

API key required for authentication.

Example: YOUR_API_KEY_HERE

Body

application/json

Responses

200

Images successfully rendered. Returns array of render results.

application/json

400

Bad request due to invalid input parameters.

401

Unauthorized request, invalid or missing API key.

post

/renders/batch

HTTPcURLJavaScriptPython

POST /api/v1/renders/batch HTTP/1.1
Host: app.dynamicmockups.com
x-api-key: YOUR_API_KEY_HERE
Accept: application/json
Content-Type: application/json
Content-Length: 593

{
  "export_options": {
    "image_format": "webp",
    "image_size": 800
  },
  "renders": [
    {
      "export_label": "render_1",
      "mockup_uuid": "661cab42-8132-46b3-a244-8a31593084ab",
      "smart_objects": [
        {
          "uuid": "c37e12f2-b022-4058-8a10-40127364fcd8",
          "asset": {
            "url": "https://app-dynamicmockups-production.s3.eu-central-1.amazonaws.com/static/api_sandbox_icon.png"
          }
        }
      ]
    },
    {
      "export_label": "render_2",
      "mockup_uuid": "bc256d5e-0e63-4b54-a7b8-4cfb42fea918",
      "smart_objects": [
        {
          "uuid": "c47871c9-bc64-4143-acad-1c73b0036f46",
          "asset": {
            "url": "https://app-dynamicmockups-production.s3.eu-central-1.amazonaws.com/static/api_sandbox_icon.png"
          }
        }
      ]
    }
  ]
}

{
  "data": {
    "total_renders": 2,
    "successful_renders": 2,
    "failed_renders": 0,
    "renders": [
      {
        "status": "success",
        "export_path": "https://app-dynamicmockups-psd-engine-production.s3.eu-central-1.amazonaws.com/variation-exports/1379dbc7-8cbd-4773-9627-4c1cb5f8c13d_4061d706-b20c-4066-bee3-bee1e2c89990.webp",
        "export_label": "render_1",
        "mockup_uuid": "661cab42-8132-46b3-a244-8a31593084ab"
      },
      {
        "status": "success",
        "export_path": "https://app-dynamicmockups-psd-engine-production.s3.eu-central-1.amazonaws.com/variation-exports/9f1674ea-1ba3-429b-8bda-7b4ac87fe1a9_21acc2c3-4eaf-4f0f-9fc6-362ede36b320.webp",
        "export_label": "render_2",
        "mockup_uuid": "bc256d5e-0e63-4b54-a7b8-4cfb42fea918"
      }
    ]
  },
  "success": true,
  "message": ""
}

Export OpenAPI specification for Render API

15KB

render_batch_api.json

Open

Generate multiple mockups in a single request

The Batch Render Mockups API allows you to generate multiple mockups in a single request. It uses the same structure and fields as the Render Mockup API, with one key difference: instead of submitting a single mockup object, you provide an array of mockups in the renders field.

Use this endpoint when you need to create several mockup images at once. While it’s possible to render images individually using multiple calls to the Render Mockup API, the batch endpoint is significantly more efficient.

Performance advantage

The Batch Render Mockups API can generate ten mockups in roughly the same time it takes the Render Mockup API to generate one, making it the recommended method for high-volume or multi-image workflows.