Documentation
Design file format & one-shot generation
The Design Document format the AI generator emits, and the API to generate or revise a complete design in one pass.
The editor can build a whole design in one pass — from a prompt, or by revising an existing design — instead of editing it step by step. Under the hood the AI produces a Design Document: a clean, declarative JSON description of the design that the server compiles into the editor's native format.
This section documents that Design Document format and the API to drive it, so you can generate designs programmatically or understand what the one-shot AI mode produces.
Two ways to run it
- In the editor — turn on One-shot full design in the AI assistant's options, then describe what you want. A blank canvas is generated; a design that already has content is revised. Progress streams live and the finished design appears when it's ready.
- Over the API —
POST /api/designs/generate(new design) orPOST /api/designs/{uuid}/revise(edit an existing one). Both run in the background; you poll for status and then load the resulting design.
What's in this section
- The document — the top-level shape: meta, styles, and artboards.
- Colors — hex, CMYK, spot/process swatches, and gradients.
- Elements — text, shapes, images, groups, and the rest.
- The API — generate, revise, poll, and cancel.
Everything is authored in your document's unit (mm, pt, px…), with positions measured from each artboard's own top-left corner.
The document
The top-level shape of a Design Document: meta, styles, and artboards.
Colors
How to express fills and strokes: hex, CMYK, swatch references, and gradients.
Elements
Every element type: text, shapes, images, paths, barcodes, groups, and more.
The API
Generate or revise a complete design over HTTP: request, poll, and load.