Introduction

The KuikCode API is a JSON REST API at:

https://api.kuikcode.com/v1

It is included from the PRO plan. Create a key under Settings, Developers in the dashboard and send it as a bearer token; see Authentication.

A first request

curl https://api.kuikcode.com/v1/me \
  -H "Authorization: Bearer kc_live_..."

GET /me returns the key you are calling with, its workspace, the plan's ceilings and current usage. It is the first call every integration should make.

Create a code

curl -X POST https://api.kuikcode.com/v1/codes \
  -H "Authorization: Bearer kc_live_..." \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: 5f3a9c2e-order-8812" \
  -d '{
    "name": "Spring menu, table tents",
    "destination": { "type": "url", "url": "https://example.com/spring-menu" },
    "tags": ["spring", "print"]
  }'

The response carries the code's id, its permanent shortCode and the scanUrl the artwork encodes. Download the designed artwork with GET /codes/{id}/image?format=png (also svg and jpg).

Change where a printed code points

curl -X PATCH https://api.kuikcode.com/v1/codes/K02bEPC2SmtopwPr6S-jt \
  -H "Authorization: Bearer kc_live_..." \
  -H "Content-Type: application/json" \
  -d '{ "destination": { "type": "url", "url": "https://example.com/summer-menu" } }'

The artwork never changes.

Conventions

• JSON in and out, UTF-8, ISO 8601 timestamps in UTC.
• Lists page with an opaque cursor, see Pagination.
• Errors share one shape and a stable set of codes, see Errors.
• Every POST accepts an Idempotency-Key, see Idempotency.
• Budgets are per key and per minute, see Rate limits.

OpenAPI

The full contract is published as OpenAPI 3.1 at https://api.kuikcode.com/v1/openapi.json. The reference pages in this section are generated from it.