Preview Auto Design variants

Reads a website's brand colours (its stylesheet and brand image) or takes a palette, and renders the batch's nine 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.

url?string

Website to take the colours from.

Formaturi

Lengthlength <= 2048

palette?array<>

Or design from these colours, lead colour first.

Items1 <= items <= 8

batch?integer

0 is the first deck; each number is a different set of four.

Range0 <= value <= 99

Default0

index?integer

Render only this variant of the batch, for example to see it recoloured.

Range0 <= value <= 8

count?integer

How many variants of the batch to render, up to 9.

Range1 <= value <= 9

Default9

colors?array<>

Recolour the variant(s): the design's colours, code first, are swapped one for one for these.

Items1 <= items <= 8

shape?string

Round or squared outline for the variant(s).

Value in

"circle"
"square"

tweaks?

Response Body

`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    }  ]}

Preview Auto Design variants

AuthorizationCopiar link a esta sección

Request BodyCopiar link a esta sección

Response BodyCopiar link a esta sección

200application/json

400application/json

403application/json

429application/json

Authorization

Request Body

Response Body

`application/json`

`application/json`

`application/json`

`application/json`