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.
openapi: 3.2.0
info:
title: Crayonz Ai Designs API
version: 1.0.0
contact:
name: Crayonz API Support
url: https://crayonz.ai/api-console
description: 'Operations tagged Designs 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: Designs
description: List and fetch designs your key has generated
paths:
/api/designs:
get:
summary: List your designs
description: Every print-ready design your key has generated, newest first, with its file_url, size, quality score, the idea it came from and the X-Crayonz-Tag it was made under. Free. GET /api/designs/{id} returns one design. Designs made before 12 Sep 2026 are not attributed.
tags:
- Designs
operationId: design_pipeline_library
security:
- ApiKeyAuth: []
parameters:
- name: tag
in: query
required: false
schema:
type: string
description: Only designs made with this X-Crayonz-Tag
example: project=launch
description: Only designs made with this X-Crayonz-Tag
- name: limit
in: query
required: false
schema:
type: integer
description: 1–200, default 50
example: 50
description: 1–200, default 50
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
status:
type: string
count:
type: integer
description: Number of rows returned (bounded by limit)
designs:
type: array
description: id, file_url, width, height, quality_score, print_ready, cut_status, idea, source, tag, created_at — one row per design
items:
type: object
example:
status: ok
count: 1
designs:
- id: a1b2…
file_url: https://…/designs/custom-…-cut.png
width: 2048
height: 2048
quality_score: 70
print_ready: true
idea: Retro 90s skate shop logo
source: custom
tag: project=launch
created_at: '2026-09-12T16:26:35Z'
'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