KuikCodeDocs
APIReferenceDesign

Preview Auto Design variants

POST
/design/auto

Reads a website's brand colours (its stylesheet and brand image) or takes a palette, and renders four designed variants. Pick one and create the code with design: { kind: "auto", url, batch, index }. Pass index and colors to see one variant in your own colours before creating it. Twelve calls per minute per key.

Authorization

apiKey
AuthorizationBearer <token>

An API key from Settings, Developers: Authorization: Bearer kc_live_...

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/design/auto" \  -H "Content-Type: application/json" \  -d '{}'
{  "palette": [    "string"  ],  "batch": 0,  "variants": [    {      "index": 0,      "archetype": "string",      "previewUrl": "string",      "scanVerified": true    }  ]}

Download the code's artwork GET

The finished design as an image: frame, stickers, logo and all, exactly what the dashboard downloads. PNG and JPG at the requested pixel size, SVG as vectors with the frame embedded as a raster. Mesh shader frames render as a gradient. Add `response=url` to get a public download link instead of the bytes.

List folders GET

The whole folder tree in one response, no paging. Group by `parentId` to rebuild it.