Crayonz Design Pipeline API
Print-ready design generation, garment mockups, printability scoring
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/crayonz-ai:crayonz-ai-design-pipeline-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Crayonz Ai Design Pipeline API
version: 1.0.0
contact:
name: Crayonz API Support
url: https://crayonz.ai/api-console
description: 'Operations tagged Design Pipeline across 2 of this provider''s published API definitions: crayonz-ai-openapi.json, crayonz-ai-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.crayonz.ai
description: Production
security:
- ApiKeyAuth: []
tags:
- name: Design Pipeline
description: Print-ready design generation, garment mockups, printability scoring
paths:
/api/design/custom:
post:
summary: Create a print-ready design from an idea
description: 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.
tags:
- Design Pipeline
operationId: design_pipeline_custom
security:
- ApiKeyAuth: []
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
idea:
type: string
example: Retro 90s skate shop logo, bold outline
style_preferences:
type: array
description: Any of minimal, bold, vintage, futuristic, hand-drawn
example:
- vintage
items:
type: string
color_preferences:
type: array
description: Hex colours to favour
example:
- '#111111'
- '#F5D400'
items:
type: string
target_products:
type: array
description: tshirt, oversized_tshirt, hoodie, zipper_hoodie, polo, acid_wash_tshirt
example:
- tshirt
items:
type: string
suggested_text:
type: string
description: Exact wording to include, if any
auto_mockups:
type: boolean
description: Also render mockups on the target products
example: false
garment_colors:
type: array
description: Garment colours for auto_mockups
example:
- black
- white
items:
type: string
use_references:
type: boolean
description: 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.
example: true
reference_image_base64:
type: string
description: Your own reference image (base64). When set, it is the only reference and the design follows it closely.
required:
- idea
example:
idea: Retro 90s skate shop logo, bold outline
style_preferences:
- vintage
color_preferences:
- '#111111'
- '#F5D400'
target_products:
- tshirt
auto_mockups: false
garment_colors:
- black
- white
use_references: true
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
status:
type: string
description: '"success" or "error"'
design_id:
type: string
description: Row id in your designs library — GET /api/designs/{id}
file_url:
type: string
description: Print-resolution, transparent PNG. Pass this to /api/mockup/render, the photoshoot endpoints and /api/quality/score.
print_ready:
type: boolean
description: False if background removal failed — the raw (uncut) file_url is still returned and cut_status tells you what happens next.
cut_status:
type: string
description: '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_prompt:
type: string
description: The brief the image model actually rendered from, after style/colour/product framing was added.
references:
type: object
description: 'Present when use_references was true: { used, queries } — how many Pinterest anchors were found and what was searched.'
example:
status: success
design_id: a1b2…
file_url: https://…/design.png
print_ready: true
enhanced_prompt: …
references:
used: 3
queries:
- retro skate shop logo design
- retro skate shop logo vintage poster design
'401':
description: Unauthorized — invalid or missing API key
'402':
description: Insufficient credits
'429':
description: Rate limit exceeded
servers:
- url: https://api.crayonz.ai
description: Production
/api/mockup/render:
post:
summary: Render a design on a product
description: '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.'
tags:
- Design Pipeline
operationId: design_pipeline_mockup
security:
- ApiKeyAuth: []
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
design_url:
type: string
description: Public https URL of a transparent PNG (e.g. file_url from /api/design/custom)
example: https://…/design.png
garment:
type: string
description: tshirt, oversized_tshirt, hoodie, zipper_hoodie, polo, acid_wash_tshirt, …
example: tshirt
color:
type: string
description: Colour name or hex from the garment's palette; defaults to black
example: Black
view:
type: string
description: front, back, left_sleeve, right_sleeve (per garment)
example: front
fill_mode:
type: string
description: contain fits inside the print area; cover fills and clips
example: contain
enum:
- contain
- cover
required:
- design_url
- garment
example:
design_url: https://…/design.png
garment: tshirt
color: Black
view: front
fill_mode: contain
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
status:
type: string
description: '"success" or "error"'
mockup_url:
type: string
description: The design composited onto the garment template, in the requested colour and view.
garment:
type: string
description: The garment slug that was rendered
color:
type: object
description: '{ name, hex } — the colour actually used (defaults to black when omitted)'
view:
type: string
description: front, back, left_sleeve or right_sleeve
credits_charged:
type: integer
description: Always 10 for this route; present for parity with the other endpoints
example:
status: success
mockup_url: https://…/mockup.png
garment: tshirt
color:
name: Black
hex: '#1A1A1A'
view: front
credits_charged: 10
'401':
description: Unauthorized — invalid or missing API key
'402':
description: Insufficient credits
'429':
description: Rate limit exceeded
servers:
- url: https://api.crayonz.ai
description: Production
/api/quality/score:
post:
summary: Score a design for printability
description: Scores a design 0–100 for printability, edge cleanliness and colour vibrancy against what it was meant to be, and checks that required text is present. Use it to gate designs before you order.
tags:
- Design Pipeline
operationId: design_pipeline_score
security:
- ApiKeyAuth: []
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
image_url:
type: string
description: Public https URL of the design (file_url from /api/design/custom)
example: https://…/design.png
design_brief:
type: string
description: What the design was meant to be, in a sentence
example: Minimal mountain badge for a hiking club, two colours
check_text:
type: string
description: Exact text that must appear in the design
example: TRAIL BUDDIES
brand_colors:
type: array
description: Hex colours the design should use
example:
- '#111111'
- '#F5D400'
items:
type: string
required:
- image_url
- design_brief
example:
image_url: https://…/design.png
design_brief: Minimal mountain badge for a hiking club, two colours
check_text: TRAIL BUDDIES
brand_colors:
- '#111111'
- '#F5D400'
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
status:
type: string
description: '"scored" or "error"'
recommendation:
type: string
description: '"approve" (overall_quality ≥7), "review" (5–7) or "reject" (<5)'
scores:
type: object
description: '1–10 per criterion: composition_balance, print_readiness, design_originality, color_harmony, brief_adherence, overall_quality (plus text_accuracy / brand_color_alignment when check_text / brand_colors were sent)'
issues:
type: array
description: Short strings describing what would print badly
items:
type: string
strengths:
type: array
description: Short strings describing what works
items:
type: string
scored_at:
type: string
description: ISO 8601 timestamp
example:
status: scored
recommendation: approve
scores:
composition_balance: 8
print_readiness: 9
design_originality: 7
color_harmony: 8
brief_adherence: 8
overall_quality: 8
issues: []
strengths:
- Clean die-cut edges
- High contrast for print
scored_at: '2026-09-13T12:00:00Z'
'401':
description: Unauthorized — invalid or missing API key
'402':
description: Insufficient credits
'429':
description: Rate limit exceeded
servers:
- url: https://api.crayonz.ai
description: Production
/api/jobs/{job_id}:
get:
summary: Poll an async job
description: Status and result of a job returned as 202 + job_id (for example by POST /api/design/custom). Poll every few seconds until status is completed, failed or cancelled; the poll_url in the 202 response is this path. Free.
tags:
- Design Pipeline
operationId: design_pipeline_job
security:
- ApiKeyAuth: []
parameters:
- name: job_id
in: path
required: true
schema:
type: string
description: The job_id from the 202 response
description: The job_id from the 202 response
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
status:
type: string
description: '"ok" when the job was found'
job:
type: object
description: id, job_type, status (queued | running | completed | failed | cancelled), progress_pct, credits_charged, result (when completed), error_code and last_error (when failed), completed_at
example:
status: ok
job:
id: 3f1c2a9e-…
job_type: design.custom
status: completed
progress_pct: 100
credits_charged: 18
result:
status: ok
designs:
- file_url: https://…/designs/cut/….png
completed_at: '2026-09-28T15:43:20Z'
'401':
description: Unauthorized — invalid or missing API key
'402':
description: Insufficient credits
'429':
description: Rate limit exceeded
servers:
- url: https://api.crayonz.ai
description: Production
components:
securitySchemes:
ApiKeyAuth:
type: apiKey
in: header
name: X-API-Key
description: API key prefixed cz_live_ (production) or cz_test_ (sandbox).
x-refined-from:
- crayonz-ai-openapi.json
- crayonz-ai-openapi.yml