Design Pipeline

Create a print-ready design from an idea

One transparent, print-resolution design from a plain-language idea, with your brand colours, style and target products. Returns a print-ready file_url you can pass to /api/mockup/render and to the photoshoot endpoints.

post/api/design/custom

Request

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

Request body

ideastring required
style_preferencesstring[]

Any of minimal, bold, vintage, futuristic, hand-drawn

color_preferencesstring[]

Hex colours to favour

target_productsstring[]

tshirt, oversized_tshirt, hoodie, zipper_hoodie, polo, acid_wash_tshirt

suggested_textstring

Exact wording to include, if any

auto_mockupsboolean

Also render mockups on the target products

garment_colorsstring[]

Garment colours for auto_mockups

use_referencesboolean

Find 2–3 Pinterest reference images for the idea and use them as style anchors, the way the studio does. Ignored when reference_image_base64 is set. Default true.

reference_image_base64string

Your own reference image (base64). When set, it is the only reference and the design follows it closely.

Example request

{
  "idea": "Retro 90s skate shop logo, bold outline",
  "style_preferences": [
    "vintage"
  ],
  "color_preferences": [
    "#111111",
    "#F5D400"
  ],
  "target_products": [
    "tshirt"
  ],
  "garment_colors": [
    "black",
    "white"
  ],
  "use_references": true
}

Response

Success

statusstring

"success" or "error"

design_idstring

Row id in your designs library — GET /api/designs/{id}

file_urlstring

Print-resolution, transparent PNG. Pass this to /api/mockup/render, the photoshoot endpoints and /api/quality/score.

print_readyboolean

False if background removal failed — the raw (uncut) file_url is still returned and cut_status tells you what happens next.

cut_statusstring

done | fallback | pending | failed. "fallback": the hosted cutter was unavailable, so file_url is a transparent file from the built-in white-key cutter (printable) and a higher-quality re-cut is queued that will replace file_url. "pending": no cut could be made yet; file_url is the raw render, print_ready is false, and the re-cut is retried for up to ~10 hours. Poll GET /api/designs/{design_id} to see file_url and print_ready update.

enhanced_promptstring

The brief the image model actually rendered from, after style/colour/product framing was added.

referencesobject

Present when use_references was true: { used, queries } — how many Pinterest anchors were found and what was searched.

Changes

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