Render Print Files API

Export Print Files

post

Returns print files for each smart object in selected mockup template.

Authorizations
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
mockup_uuidstringRequired

The UUID of the mockup template.

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

A label for the exported image.

Example: MY_FIRST_IMAGE_01
Responses
200
Print files successfully exported.
application/json
post
POST /api/v1/renders/print-files HTTP/1.1
Host: app.dynamicmockups.com
x-api-key: YOUR_API_KEY_HERE
Accept: application/json
Content-Type: application/json
Content-Length: 860

{
  "mockup_uuid": "754a46c5-7693-43a1-9cd4-aedabd273f57",
  "export_label": "MY_FIRST_IMAGE_01",
  "export_options": {
    "image_format": "jpg",
    "image_size": 1500,
    "mode": "view",
    "image_dpi": 300
  },
  "smart_objects": [
    {
      "uuid": "0ff99239-c91a-47f8-86e6-61229ff93626",
      "asset": {
        "url": "https://app-dynamicmockups-production.s3.eu-central-1.amazonaws.com/static/api_sandbox_icon.png",
        "fit": "stretch",
        "size": {
          "width": 100,
          "height": 100
        },
        "position": {
          "top": 100,
          "left": 100
        },
        "rotate": 180
      },
      "pattern": {
        "enabled": true,
        "scale_percent": 60
      },
      "color": "#444ABF",
      "blending_mode": "MULTIPLY",
      "adjustment_layers": {
        "brightness": 100,
        "contrast": 50,
        "opacity": 100,
        "saturation": 0,
        "vibrance": -20,
        "blur": 20
      },
      "print_area_preset_uuid": "d542b299-7350-495e-8bed-51060318d45"
    }
  ],
  "text_layers": [
    {
      "uuid": "5fea4761-8e6c-458a-b957-313e95c960d0",
      "text": "Sample Text",
      "font_family": "Arial",
      "font_size": 24,
      "font_color": "#FF5733"
    }
  ]
}
{
  "data": {
    "export_label": null,
    "print_files": [
      {
        "export_path": "https://app-dynamicmockups-psd-engine-production.s3.eu-central-1.amazonaws.com/print-exports/43180a3b-fdfe-49ed-8b43-136f65e56ef9_d40b63ce-3edc-0743-8cf6-a4c420cd040c_5c815568-2972-4b72-aa36-556cba39a9ce.png",
        "smart_object_uuid": "093ec28a-531a-4546-a424-aa7dd8a5d4dd",
        "smart_object_name": "T-shirt"
      }
    ]
  },
  "success": true,
  "message": ""
}

Export OpenAPI specification for Render Print Files API

Explanation

The Render Print Files API is used to export print files of all smart objects in a mockup template and is mostly used for printing purposes.

The request payload used for this API is the same that the Render API uses.

The only additional option is export_options.image_dpi

export_options.image_dpi

An optional parameter, the default DPI(Dots Per Inch), will be inherited from the PSD file.

Credits usage calculation

The Render Print Files API consumes 2 credits for each exported print file.

Last updated

Was this helpful?