Render a photo mockup

const response = await fetch("https://api.sudomock.com/api/v1/photo-mockups/3fa85f64-5717-4562-b3fc-2c963f66afa6/render", {
  method: "POST",
  headers: {
    "x-api-key": "sm_your_api_key",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "export_options": {
      "image_format": "webp",
      "image_size": 1920,
      "quality": 95
    },
    "print_areas": [
      {
        "adjustments": {
          "blend_mode": "multiply",
          "opacity": 90
        },
        "artwork_url": "https://example.com/design.png",
        "placement": {
          "fit": "fit",
          "position": "center"
        },
        "uuid": "223e4567-e89b-12d3-a456-426614174001"
      }
    ]
  }),
});

const data = await response.json();
console.log(data);

<?php

$payload = <<<'JSON'
{
  "export_options": {
    "image_format": "webp",
    "image_size": 1920,
    "quality": 95
  },
  "print_areas": [
    {
      "adjustments": {
        "blend_mode": "multiply",
        "opacity": 90
      },
      "artwork_url": "https://example.com/design.png",
      "placement": {
        "fit": "fit",
        "position": "center"
      },
      "uuid": "223e4567-e89b-12d3-a456-426614174001"
    }
  ]
}
JSON;

$ch = curl_init("https://api.sudomock.com/api/v1/photo-mockups/3fa85f64-5717-4562-b3fc-2c963f66afa6/render");
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: sm_your_api_key",
    "Content-Type: application/json",
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, $payload);

$response = curl_exec($ch);
curl_close($ch);

echo $response;

import requests

payload = {
    "export_options": {
        "image_format": "webp",
        "image_size": 1920,
        "quality": 95
    },
    "print_areas": [
        {
            "adjustments": {
                "blend_mode": "multiply",
                "opacity": 90
            },
            "artwork_url": "https://example.com/design.png",
            "placement": {
                "fit": "fit",
                "position": "center"
            },
            "uuid": "223e4567-e89b-12d3-a456-426614174001"
        }
    ]
}

response = requests.post(
    "https://api.sudomock.com/api/v1/photo-mockups/3fa85f64-5717-4562-b3fc-2c963f66afa6/render",
    headers={"x-api-key": "sm_your_api_key"},
    json=payload,
)

response.raise_for_status()
print(response.json())

require "net/http"
require "uri"

uri = URI("https://api.sudomock.com/api/v1/photo-mockups/3fa85f64-5717-4562-b3fc-2c963f66afa6/render")
request = Net::HTTP::Post.new(uri)
request["x-api-key"] = "sm_your_api_key"
request["Content-Type"] = "application/json"

request.body = <<~JSON
  {
    "export_options": {
      "image_format": "webp",
      "image_size": 1920,
      "quality": 95
    },
    "print_areas": [
      {
        "adjustments": {
          "blend_mode": "multiply",
          "opacity": 90
        },
        "artwork_url": "https://example.com/design.png",
        "placement": {
          "fit": "fit",
          "position": "center"
        },
        "uuid": "223e4567-e89b-12d3-a456-426614174001"
      }
    ]
  }
JSON

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) do |http|
  http.request(request)
end

puts response.body

package main

import (
	"bytes"
	"fmt"
	"io"
	"net/http"
)

func main() {
	payload := []byte(`{
  "export_options": {
    "image_format": "webp",
    "image_size": 1920,
    "quality": 95
  },
  "print_areas": [
    {
      "adjustments": {
        "blend_mode": "multiply",
        "opacity": 90
      },
      "artwork_url": "https://example.com/design.png",
      "placement": {
        "fit": "fit",
        "position": "center"
      },
      "uuid": "223e4567-e89b-12d3-a456-426614174001"
    }
  ]
}`)

	req, err := http.NewRequest("POST", "https://api.sudomock.com/api/v1/photo-mockups/3fa85f64-5717-4562-b3fc-2c963f66afa6/render", bytes.NewBuffer(payload))
	if err != nil {
		panic(err)
	}
	req.Header.Set("x-api-key", "sm_your_api_key")
	req.Header.Set("Content-Type", "application/json")

	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()

	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

String payload = """
{
  "export_options": {
    "image_format": "webp",
    "image_size": 1920,
    "quality": 95
  },
  "print_areas": [
    {
      "adjustments": {
        "blend_mode": "multiply",
        "opacity": 90
      },
      "artwork_url": "https://example.com/design.png",
      "placement": {
        "fit": "fit",
        "position": "center"
      },
      "uuid": "223e4567-e89b-12d3-a456-426614174001"
    }
  ]
}
""";

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.sudomock.com/api/v1/photo-mockups/3fa85f64-5717-4562-b3fc-2c963f66afa6/render"))
    .header("x-api-key", "sm_your_api_key")
    .header("Content-Type", "application/json")
    .POST(HttpRequest.BodyPublishers.ofString(payload))
    .build();

HttpResponse<String> response = HttpClient.newHttpClient()
    .send(request, HttpResponse.BodyHandlers.ofString());

System.out.println(response.body());

using System.Net.Http;
using System.Text;

var payload = """
{
  "export_options": {
    "image_format": "webp",
    "image_size": 1920,
    "quality": 95
  },
  "print_areas": [
    {
      "adjustments": {
        "blend_mode": "multiply",
        "opacity": 90
      },
      "artwork_url": "https://example.com/design.png",
      "placement": {
        "fit": "fit",
        "position": "center"
      },
      "uuid": "223e4567-e89b-12d3-a456-426614174001"
    }
  ]
}
""";

var request = new HttpRequestMessage(HttpMethod.Post, "https://api.sudomock.com/api/v1/photo-mockups/3fa85f64-5717-4562-b3fc-2c963f66afa6/render");
request.Headers.Add("x-api-key", "sm_your_api_key");
request.Content = new StringContent(payload, Encoding.UTF8, "application/json");

var client = new HttpClient();
var response = await client.SendAsync(request);

Console.WriteLine(await response.Content.ReadAsStringAsync());

curl -X POST "https://api.sudomock.com/api/v1/photo-mockups/3fa85f64-5717-4562-b3fc-2c963f66afa6/render" \
  -H "x-api-key: sm_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "export_options": {
      "image_format": "webp",
      "image_size": 1920,
      "quality": 95
    },
    "print_areas": [
      {
        "adjustments": {
          "blend_mode": "multiply",
          "opacity": 90
        },
        "artwork_url": "https://example.com/design.png",
        "placement": {
          "fit": "fit",
          "position": "center"
        },
        "uuid": "223e4567-e89b-12d3-a456-426614174001"
      }
    ]
  }'

{
  "data": {
    "print_files": [
      {
        "export_path": "string"
      }
    ]
  }
}

POST

api

photo-mockups

{mockup_id}

render

const response = await fetch("https://api.sudomock.com/api/v1/photo-mockups/3fa85f64-5717-4562-b3fc-2c963f66afa6/render", {
  method: "POST",
  headers: {
    "x-api-key": "sm_your_api_key",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "export_options": {
      "image_format": "webp",
      "image_size": 1920,
      "quality": 95
    },
    "print_areas": [
      {
        "adjustments": {
          "blend_mode": "multiply",
          "opacity": 90
        },
        "artwork_url": "https://example.com/design.png",
        "placement": {
          "fit": "fit",
          "position": "center"
        },
        "uuid": "223e4567-e89b-12d3-a456-426614174001"
      }
    ]
  }),
});

const data = await response.json();
console.log(data);

<?php

$payload = <<<'JSON'
{
  "export_options": {
    "image_format": "webp",
    "image_size": 1920,
    "quality": 95
  },
  "print_areas": [
    {
      "adjustments": {
        "blend_mode": "multiply",
        "opacity": 90
      },
      "artwork_url": "https://example.com/design.png",
      "placement": {
        "fit": "fit",
        "position": "center"
      },
      "uuid": "223e4567-e89b-12d3-a456-426614174001"
    }
  ]
}
JSON;

$ch = curl_init("https://api.sudomock.com/api/v1/photo-mockups/3fa85f64-5717-4562-b3fc-2c963f66afa6/render");
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: sm_your_api_key",
    "Content-Type: application/json",
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, $payload);

$response = curl_exec($ch);
curl_close($ch);

echo $response;

import requests

payload = {
    "export_options": {
        "image_format": "webp",
        "image_size": 1920,
        "quality": 95
    },
    "print_areas": [
        {
            "adjustments": {
                "blend_mode": "multiply",
                "opacity": 90
            },
            "artwork_url": "https://example.com/design.png",
            "placement": {
                "fit": "fit",
                "position": "center"
            },
            "uuid": "223e4567-e89b-12d3-a456-426614174001"
        }
    ]
}

response = requests.post(
    "https://api.sudomock.com/api/v1/photo-mockups/3fa85f64-5717-4562-b3fc-2c963f66afa6/render",
    headers={"x-api-key": "sm_your_api_key"},
    json=payload,
)

response.raise_for_status()
print(response.json())

require "net/http"
require "uri"

uri = URI("https://api.sudomock.com/api/v1/photo-mockups/3fa85f64-5717-4562-b3fc-2c963f66afa6/render")
request = Net::HTTP::Post.new(uri)
request["x-api-key"] = "sm_your_api_key"
request["Content-Type"] = "application/json"

request.body = <<~JSON
  {
    "export_options": {
      "image_format": "webp",
      "image_size": 1920,
      "quality": 95
    },
    "print_areas": [
      {
        "adjustments": {
          "blend_mode": "multiply",
          "opacity": 90
        },
        "artwork_url": "https://example.com/design.png",
        "placement": {
          "fit": "fit",
          "position": "center"
        },
        "uuid": "223e4567-e89b-12d3-a456-426614174001"
      }
    ]
  }
JSON

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) do |http|
  http.request(request)
end

puts response.body

package main

import (
	"bytes"
	"fmt"
	"io"
	"net/http"
)

func main() {
	payload := []byte(`{
  "export_options": {
    "image_format": "webp",
    "image_size": 1920,
    "quality": 95
  },
  "print_areas": [
    {
      "adjustments": {
        "blend_mode": "multiply",
        "opacity": 90
      },
      "artwork_url": "https://example.com/design.png",
      "placement": {
        "fit": "fit",
        "position": "center"
      },
      "uuid": "223e4567-e89b-12d3-a456-426614174001"
    }
  ]
}`)

	req, err := http.NewRequest("POST", "https://api.sudomock.com/api/v1/photo-mockups/3fa85f64-5717-4562-b3fc-2c963f66afa6/render", bytes.NewBuffer(payload))
	if err != nil {
		panic(err)
	}
	req.Header.Set("x-api-key", "sm_your_api_key")
	req.Header.Set("Content-Type", "application/json")

	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()

	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

String payload = """
{
  "export_options": {
    "image_format": "webp",
    "image_size": 1920,
    "quality": 95
  },
  "print_areas": [
    {
      "adjustments": {
        "blend_mode": "multiply",
        "opacity": 90
      },
      "artwork_url": "https://example.com/design.png",
      "placement": {
        "fit": "fit",
        "position": "center"
      },
      "uuid": "223e4567-e89b-12d3-a456-426614174001"
    }
  ]
}
""";

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.sudomock.com/api/v1/photo-mockups/3fa85f64-5717-4562-b3fc-2c963f66afa6/render"))
    .header("x-api-key", "sm_your_api_key")
    .header("Content-Type", "application/json")
    .POST(HttpRequest.BodyPublishers.ofString(payload))
    .build();

HttpResponse<String> response = HttpClient.newHttpClient()
    .send(request, HttpResponse.BodyHandlers.ofString());

System.out.println(response.body());

using System.Net.Http;
using System.Text;

var payload = """
{
  "export_options": {
    "image_format": "webp",
    "image_size": 1920,
    "quality": 95
  },
  "print_areas": [
    {
      "adjustments": {
        "blend_mode": "multiply",
        "opacity": 90
      },
      "artwork_url": "https://example.com/design.png",
      "placement": {
        "fit": "fit",
        "position": "center"
      },
      "uuid": "223e4567-e89b-12d3-a456-426614174001"
    }
  ]
}
""";

var request = new HttpRequestMessage(HttpMethod.Post, "https://api.sudomock.com/api/v1/photo-mockups/3fa85f64-5717-4562-b3fc-2c963f66afa6/render");
request.Headers.Add("x-api-key", "sm_your_api_key");
request.Content = new StringContent(payload, Encoding.UTF8, "application/json");

var client = new HttpClient();
var response = await client.SendAsync(request);

Console.WriteLine(await response.Content.ReadAsStringAsync());

curl -X POST "https://api.sudomock.com/api/v1/photo-mockups/3fa85f64-5717-4562-b3fc-2c963f66afa6/render" \
  -H "x-api-key: sm_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "export_options": {
      "image_format": "webp",
      "image_size": 1920,
      "quality": 95
    },
    "print_areas": [
      {
        "adjustments": {
          "blend_mode": "multiply",
          "opacity": 90
        },
        "artwork_url": "https://example.com/design.png",
        "placement": {
          "fit": "fit",
          "position": "center"
        },
        "uuid": "223e4567-e89b-12d3-a456-426614174001"
      }
    ]
  }'

{
  "data": {
    "print_files": [
      {
        "export_path": "string"
      }
    ]
  }
}

const response = await fetch("https://api.sudomock.com/api/v1/photo-mockups/3fa85f64-5717-4562-b3fc-2c963f66afa6/render", {
  method: "POST",
  headers: {
    "x-api-key": "sm_your_api_key",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "export_options": {
      "image_format": "webp",
      "image_size": 1920,
      "quality": 95
    },
    "print_areas": [
      {
        "adjustments": {
          "blend_mode": "multiply",
          "opacity": 90
        },
        "artwork_url": "https://example.com/design.png",
        "placement": {
          "fit": "fit",
          "position": "center"
        },
        "uuid": "223e4567-e89b-12d3-a456-426614174001"
      }
    ]
  }),
});

const data = await response.json();
console.log(data);

<?php

$payload = <<<'JSON'
{
  "export_options": {
    "image_format": "webp",
    "image_size": 1920,
    "quality": 95
  },
  "print_areas": [
    {
      "adjustments": {
        "blend_mode": "multiply",
        "opacity": 90
      },
      "artwork_url": "https://example.com/design.png",
      "placement": {
        "fit": "fit",
        "position": "center"
      },
      "uuid": "223e4567-e89b-12d3-a456-426614174001"
    }
  ]
}
JSON;

$ch = curl_init("https://api.sudomock.com/api/v1/photo-mockups/3fa85f64-5717-4562-b3fc-2c963f66afa6/render");
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: sm_your_api_key",
    "Content-Type: application/json",
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, $payload);

$response = curl_exec($ch);
curl_close($ch);

echo $response;

import requests

payload = {
    "export_options": {
        "image_format": "webp",
        "image_size": 1920,
        "quality": 95
    },
    "print_areas": [
        {
            "adjustments": {
                "blend_mode": "multiply",
                "opacity": 90
            },
            "artwork_url": "https://example.com/design.png",
            "placement": {
                "fit": "fit",
                "position": "center"
            },
            "uuid": "223e4567-e89b-12d3-a456-426614174001"
        }
    ]
}

response = requests.post(
    "https://api.sudomock.com/api/v1/photo-mockups/3fa85f64-5717-4562-b3fc-2c963f66afa6/render",
    headers={"x-api-key": "sm_your_api_key"},
    json=payload,
)

response.raise_for_status()
print(response.json())

require "net/http"
require "uri"

uri = URI("https://api.sudomock.com/api/v1/photo-mockups/3fa85f64-5717-4562-b3fc-2c963f66afa6/render")
request = Net::HTTP::Post.new(uri)
request["x-api-key"] = "sm_your_api_key"
request["Content-Type"] = "application/json"

request.body = <<~JSON
  {
    "export_options": {
      "image_format": "webp",
      "image_size": 1920,
      "quality": 95
    },
    "print_areas": [
      {
        "adjustments": {
          "blend_mode": "multiply",
          "opacity": 90
        },
        "artwork_url": "https://example.com/design.png",
        "placement": {
          "fit": "fit",
          "position": "center"
        },
        "uuid": "223e4567-e89b-12d3-a456-426614174001"
      }
    ]
  }
JSON

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) do |http|
  http.request(request)
end

puts response.body

package main

import (
	"bytes"
	"fmt"
	"io"
	"net/http"
)

func main() {
	payload := []byte(`{
  "export_options": {
    "image_format": "webp",
    "image_size": 1920,
    "quality": 95
  },
  "print_areas": [
    {
      "adjustments": {
        "blend_mode": "multiply",
        "opacity": 90
      },
      "artwork_url": "https://example.com/design.png",
      "placement": {
        "fit": "fit",
        "position": "center"
      },
      "uuid": "223e4567-e89b-12d3-a456-426614174001"
    }
  ]
}`)

	req, err := http.NewRequest("POST", "https://api.sudomock.com/api/v1/photo-mockups/3fa85f64-5717-4562-b3fc-2c963f66afa6/render", bytes.NewBuffer(payload))
	if err != nil {
		panic(err)
	}
	req.Header.Set("x-api-key", "sm_your_api_key")
	req.Header.Set("Content-Type", "application/json")

	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()

	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

String payload = """
{
  "export_options": {
    "image_format": "webp",
    "image_size": 1920,
    "quality": 95
  },
  "print_areas": [
    {
      "adjustments": {
        "blend_mode": "multiply",
        "opacity": 90
      },
      "artwork_url": "https://example.com/design.png",
      "placement": {
        "fit": "fit",
        "position": "center"
      },
      "uuid": "223e4567-e89b-12d3-a456-426614174001"
    }
  ]
}
""";

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.sudomock.com/api/v1/photo-mockups/3fa85f64-5717-4562-b3fc-2c963f66afa6/render"))
    .header("x-api-key", "sm_your_api_key")
    .header("Content-Type", "application/json")
    .POST(HttpRequest.BodyPublishers.ofString(payload))
    .build();

HttpResponse<String> response = HttpClient.newHttpClient()
    .send(request, HttpResponse.BodyHandlers.ofString());

System.out.println(response.body());

using System.Net.Http;
using System.Text;

var payload = """
{
  "export_options": {
    "image_format": "webp",
    "image_size": 1920,
    "quality": 95
  },
  "print_areas": [
    {
      "adjustments": {
        "blend_mode": "multiply",
        "opacity": 90
      },
      "artwork_url": "https://example.com/design.png",
      "placement": {
        "fit": "fit",
        "position": "center"
      },
      "uuid": "223e4567-e89b-12d3-a456-426614174001"
    }
  ]
}
""";

var request = new HttpRequestMessage(HttpMethod.Post, "https://api.sudomock.com/api/v1/photo-mockups/3fa85f64-5717-4562-b3fc-2c963f66afa6/render");
request.Headers.Add("x-api-key", "sm_your_api_key");
request.Content = new StringContent(payload, Encoding.UTF8, "application/json");

var client = new HttpClient();
var response = await client.SendAsync(request);

Console.WriteLine(await response.Content.ReadAsStringAsync());

curl -X POST "https://api.sudomock.com/api/v1/photo-mockups/3fa85f64-5717-4562-b3fc-2c963f66afa6/render" \
  -H "x-api-key: sm_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "export_options": {
      "image_format": "webp",
      "image_size": 1920,
      "quality": 95
    },
    "print_areas": [
      {
        "adjustments": {
          "blend_mode": "multiply",
          "opacity": 90
        },
        "artwork_url": "https://example.com/design.png",
        "placement": {
          "fit": "fit",
          "position": "center"
        },
        "uuid": "223e4567-e89b-12d3-a456-426614174001"
      }
    ]
  }'

{
  "data": {
    "print_files": [
      {
        "export_path": "string"
      }
    ]
  }
}

Authorizations

x-api-key

string

header

required

API key with sm_ prefix. Get your key at https://sudomock.com/dashboard/api-keys

Path Parameters

mockup_id

string

required

Body

application/json

Body for POST /api/v1/photo-mockups/{mockup_id}/render.

The mockup UUID is taken from the path; the body carries only per-print-area artwork configuration and export options.

print_areas

PhotoMockupPrintAreaRender · object[]

required

Artwork configuration per render target. Use uuid for a saved print area, and surface_uuid for a whole product surface. A product can be rendered either way, and saving a print area on it does not take its surface away.

Required array length: 1 - 8 elements

Hide child attributes

print_areas.uuid

string | null

UUID of a saved print area, a bounded zone drawn on a product.

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Example:

"19be48d4-c810-4420-86e3-7ec2a4d85571"

print_areas.surface_uuid

string | null

UUID of a printable product surface. A product carrying saved print areas still has one, and it is a separate render target from them.

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Example:

"733ee99a-f41f-4b9b-bf33-2ffa489f96db"

print_areas.base64

string | null

Base64-encoded artwork image.

print_areas.artwork_url

string | null

Artwork image URL

Example:

"https://example.com/design.png"

print_areas.color

string | null

Solid color as a hex code (e.g., '#FF0000'), or the name of a colour saved on this mockup (e.g., 'blue jean'). Names match exactly and are set with PATCH /api/v1/photo-mockups/{uuid}.

Example:

"#6A8296"

print_areas.adjustments

PhotoMockupAdjustments · object | null

Optional visual adjustments for the artwork.

Hide child attributes

print_areas.adjustments.brightness

integer

default:0

Required range: -150 <= x <= 150

print_areas.adjustments.contrast

integer

default:0

Required range: -100 <= x <= 100

print_areas.adjustments.opacity

integer

default:100

Required range: 0 <= x <= 100

print_areas.adjustments.saturation

integer

default:0

Required range: -100 <= x <= 100

print_areas.adjustments.vibrance

integer

default:0

Required range: -100 <= x <= 100

print_areas.adjustments.blur

integer

default:0

Required range: 0 <= x <= 100

print_areas.adjustments.blend_mode

enum<string>

default:multiply

How the artwork sits on the product surface. 'multiply' keeps the material texture visible and is the best choice on light fabric (default); 'normal' reproduces the artwork colors exactly, whatever the product color, and is the right choice when a brand color has to match the supplied file; 'screen' lightens the artwork against the surface, which is worth reaching for only when you want that lighter result, since the default already adapts to a dark garment; 'lighten' keeps the artwork only where it is brighter than the surface; 'soft_light' gives a subtle, low-contrast finish that follows the surface; 'overlay' deepens contrast so the artwork reads as part of the material; 'darken' keeps the artwork only where it is darker than the surface.

Available options:

multiply,

normal,

screen,

lighten,

soft_light,

overlay,

darken

print_areas.placement

PhotoMockupPlacement · object | null

Where the artwork sits and how big it is. position, offset_x, offset_y and rotation apply to either target. Sizing follows the target: coverage on a surface_uuid target, and either fit or an explicit width and height on a uuid target.

Hide child attributes

print_areas.placement.position

enum<string>

default:center

Predefined position within print area

Available options:

center,

top_left,

top_center,

top_right,

center_left,

center_right,

left_center,

right_center,

bottom_left,

bottom_center,

bottom_right

print_areas.placement.coverage

integer | null

How much of the product surface the artwork spans, 10 to 100. Spans the whole surface by default. Belongs to a surface_uuid target, and cannot be combined with an explicit width and height.

Required range: 10 <= x <= 100

print_areas.placement.fit

enum<string> | null

How the artwork meets the print area. 'fit' scales it until it fits inside and keeps its proportions, which is the default and can leave empty space. 'fill' stretches it to the edges and does not keep proportions. 'crop' covers the area and cuts the overflow, keeping proportions. 'contain' and 'cover' are the older names for 'fit' and 'crop' and are still accepted. Always targets the whole print area. Belongs to a uuid target, and cannot be combined with an explicit width and height.

Available options:

fill,

fit,

crop

print_areas.placement.offset_x

number

default:0

Horizontal offset in print-area pixels, measured from the anchor that 'position' picks, positive right. With the default position of 'center' that anchor is the middle of the print area.

print_areas.placement.offset_y

number

default:0

Vertical offset in print-area pixels, measured from the anchor that 'position' picks, positive down. With the default position of 'center' that anchor is the middle of the print area.

print_areas.placement.width

number | null

Artwork width in target pixels. Must be sent together with 'height'. An exact box belongs to either kind of target: send it instead of 'fit' on a print area, or instead of 'coverage' on a surface. Width and height are independent, so any aspect ratio is allowed.

Required range: 1 <= x <= 30000

print_areas.placement.height

number | null

Artwork height in target pixels. Must be sent together with 'width'. An exact box belongs to either kind of target: send it instead of 'fit' on a print area, or instead of 'coverage' on a surface. Width and height are independent, so any aspect ratio is allowed.

Required range: 1 <= x <= 30000

print_areas.placement.rotation

number

default:0

Rotation in degrees (clockwise positive)

Required range: -360 <= x <= 360

print_areas.flip_horizontal

boolean

default:false

Flip artwork horizontally (left-right mirror)

print_areas.flip_vertical

boolean

default:false

Flip artwork vertically (top-bottom mirror)

print_areas.remove_background

boolean

default:false

Remove the image background before placing the artwork; the subject is isolated onto a clean transparent cutout. Adds 25 credits per artwork to the render cost.

export_options

ExportOptions · object

Export configuration for format, size and quality. Every field has a default, so the whole object is optional.

Hide child attributes

export_options.image_format

enum<string>

default:webp

Output format: 'webp' (30-70% smaller, recommended), 'png' (lossless), 'jpg' (smallest, no transparency)

Available options:

png,

jpg,

webp

export_options.image_size

integer

default:2048

Output width in pixels (100-10000). Height auto-calculated from the source aspect ratio. Powers of 2 (1024, 2048, 4096) recommended for best quality. Renders on an account in trial are capped at 1024: a larger image_size is rejected with error_code OUTPUT_RESOLUTION_LIMIT (HTTP 402) and is never silently downscaled. Add a payment method to render at full width.

Required range: 100 <= x <= 10000

export_options.quality

integer

default:90

Compression quality for JPG/WebP (1-100). Ignored for PNG (always lossless). Default: 90.

Required range: 1 <= x <= 100

export_options.dpi

integer | null

Resolution tag stamped into the output file metadata (JPG/WebP via Exif XResolution, PNG via pHYs), e.g. 300 for print. This is metadata only: it does NOT change the pixels. Pixel dimensions are controlled by image_size: set image_size = print_size_inches * dpi for a true print-ready file (e.g. 12 in * 300 = 3600 px). Range 72-2400. Default: null (opt-in). Omitting it does not leave the file untagged: the encoder writes a default ~25.4 DPI (1 px/mm) tag. All three formats carry the tag, but for maximum print-tool compatibility prefer jpg or png, because WebP stores resolution in Exif and not every viewer surfaces it.

Required range: 72 <= x <= 2400

Example:

300

Example:

{
  "image_format": "webp",
  "image_size": 2048,
  "quality": 95
}

is_async

boolean

default:false

If true, the render is QUEUED and the call returns 202 immediately with a job_id (poll GET /api/v1/jobs/{job_id}, or receive a webhook if one is configured); result_url carries the rendered image URL on success. If false (default), the render runs synchronously and returns the result.

Response

Successful Response

The finished photo-mockup render and where to fetch it.

data

PhotoMockupRenderResult · object

required

Rendered output files

Hide child attributes

data.print_files

PhotoMockupPrintFile · object[]

required

List of rendered outputs

Hide child attributes

data.print_files.export_path

string

required

Public URL of the rendered output

data.print_files.duration_ms

integer | null

Render duration in milliseconds

data.print_files.export_format

string | null

Output format used (png, jpg, webp)

data.render_uuid

string | null

Identifier for this render.

success

boolean

default:true

Success status

⌘I

API reference

PSD mockups

Photo mockups

Fonts

Video mockups

Background removal

Studio

Webhook endpoints

Webhook deliveries

Jobs

Account

Render a photo mockup

Authorizations

Path Parameters

Body

Response