SudoMockInstall

Summary

Create a new 2D photo mockup from an image source, either by providing a public image URL or base64-encoded image data. Optionally, specify a human-readable name, define print areas by their corner points, and control whether the creation is processed asynchronously to receive a job ID immediately.

Inputs

• Source Type (required) — Select the image source type, either Image URL or Base64 Image data.
• Source URL (required) — Public image URL to create the photo mockup from (required if Source Type is Image URL).
• Source Base64 (required) — Base64-encoded image data to create the photo mockup from (required if Source Type is Base64 Image).
• Name — Optional human-readable name for the new photo mockup.
• Print Areas — Optional list of print areas to set during creation, each defined by four X/Y coordinate points representing corners of a quadrilateral print area.
• Run Asynchronously — If true, queues the creation as a background job and immediately returns a job ID; otherwise, creation is processed synchronously and the mockup data is returned directly.

Output shape

a single JSON object representing the created photo mockup or an immediate job ID if asynchronous mode is used

If Run Asynchronously is true, the response includes a job_id of kind photo_mockup_create; otherwise, the created mockup data is returned inline. The optional Print Areas are converted from UI coordinates to a points array of [X, Y] pairs for the API. Errors can occur if required inputs are missing or if API limits are exceeded.

Examples

Example 1: Synchronous creation from image URL with print areas

Set Source Type to 'Image URL', provide Source URL, optionally add a Name and one or more Print Areas, with Run Asynchronously false (default). The node returns the created photo mockup object directly.

Example 2: Asynchronous creation from base64 image data

Set Source Type to 'Base64 Image', provide the base64 string, optionally add a Name, leave Print Areas empty or omit them, and enable Run Asynchronously. The node returns a job_id immediately for tracking the background creation process.

Links

• n8n community nodes installation guide