Design Pipeline

Render a design on a product

Garment-accurate mockup: your print-ready design placed on a real product template in a real colour, with fabric overlay. GET the same path to list garments, colours and printable views.

post/api/mockup/render

Request

  • Base URL: https://api.crayonz.ai
  • URL: https://api.crayonz.ai/api/mockup/render
  • Auth: API key in header X-API-Key

Request body

design_urlstring required

Public https URL of a transparent PNG (e.g. file_url from /api/design/custom)

garmentstring required

tshirt, oversized_tshirt, hoodie, zipper_hoodie, polo, acid_wash_tshirt, …

colorstring

Colour name or hex from the garment's palette; defaults to black

viewstring

front, back, left_sleeve, right_sleeve (per garment)

fill_mode'contain' | 'cover'

contain fits inside the print area; cover fills and clips

Example request

{
  "design_url": "https://…/design.png",
  "garment": "tshirt",
  "color": "Black",
  "view": "front",
  "fill_mode": "contain"
}

Response

Success

statusstring

"success" or "error"

mockup_urlstring

The design composited onto the garment template, in the requested colour and view.

garmentstring

The garment slug that was rendered

colorobject

{ name, hex } — the colour actually used (defaults to black when omitted)

viewstring

front, back, left_sleeve or right_sleeve

credits_chargedinteger

Always 10 for this route; present for parity with the other endpoints

Changes

No recorded changes to this operation across all 1 revision of this API.