Preview a restyle of a code
Renders the code with new colours, shape or tweaks applied, without saving anything. Then PATCH the same fields to make it real.
Authorization
apiKey An API key from Settings, Developers: Authorization: Bearer kc_live_...
In: header
Path Parameters
1 <= lengthRequest 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/codes/string/preview" \ -H "Content-Type: application/json" \ -d '{}'{ "previewUrl": "string", "warnings": [ "string" ]}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.
Preview Auto Design variants POST
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.