Create a preview mockup
create_mockupIdempotent
Render a preview PNG of the artwork on the product in the chosen colour and placement. style flat draws the placement; style packshot uses a product photo with the exact print at real size, or gives the flat preview with a note when no photo exists. Returns mockup_url, blank_image_url and image_prompt (an optional text prompt for an illustration of a person who wears the product; such an image is an illustration, not the exact print). Optional.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| size | No | ||
| color | Yes | Product colour, e.g. "black". | |
| style | No | flat: quick placement drawing. packshot: product photo with the exact print at real size (where a product photo exists). | flat |
| preset | No | Named position inside the placement, e.g. "center_chest", "left_chest", "full_front". Defaults to the placement default. | |
| top_mm | No | Distance from the top of the print area to the top of the artwork. | |
| left_mm | No | Distance from the left edge of the print area. Default: horizontally centred. | |
| width_mm | No | Exact printed width of the visible artwork in millimetres. Height follows the aspect ratio. | |
| height_mm | No | Maximum printed height in millimetres. | |
| placement | No | Print location on the product, e.g. "front" or "back". See get_product for the list. | front |
| artwork_id | Yes | ||
| product_id | Yes |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| note | Yes | ||
| style | Yes | ||
| summary | Yes | ||
| mockup_url | Yes | PNG preview of the exact print on the product. | |
| image_prompt | Yes | A prompt for your own image model, to make an illustration from mockup_url. | |
| blank_image_url | Yes | ||
| validation_status | Yes |