KuikCodeDocs
APIReferenceDesign

Preview any design

POST
/design/preview

Renders exactly what POST /codes would save for this design (a template with new colours, a plain code with a gold frame, an Auto Design variant with SCAN on top) without creating anything. Same render budget as /design/auto.

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

application/json

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