Skip to main content
POST
Generate Mockup

Generate Mockup

Composite a design image onto a garment blank to create a realistic mockup.
Each generation costs 1 token.

Endpoint

Request Body

string
required
URL of the design image to place on the garment. Must be publicly accessible.
string
required
ID of the garment from the /garments endpoint.
string
required
Direct URL to the garment blank image (specific color variant).
string
Color variant name (e.g., “Black”, “White”, “Navy”).
string
default:"front"
Print zone to use. Options: front, back, left-chest, right-chest.
object
Design placement configuration.
boolean
default:"true"
Apply subtle fabric texture effect for realism.
string
URL to receive a POST callback when generation completes.

Response

string
Unique generation ID (e.g., gen_1703001234_abc123).
string
Generation status: pending, processing, completed, or failed.
string
URL of the generated mockup image (when completed).
string
URL of a smaller thumbnail version.
number
Number of tokens consumed (always 1).
string
ISO 8601 timestamp of when the generation started.
string
ISO 8601 timestamp of when the generation finished.
string
Error message if status is failed.

Example

Response Example

Webhooks

If you provide a webhookUrl, we’ll POST the completed generation to your endpoint:
Webhook requests have a 10-second timeout. Respond with a 200 status quickly.

Errors