Changelog and versioning

VersioningCopy Anchor Link

The API is versioned in the path: /v1. Within a version we may at any time:

• add endpoints,
• add fields to responses,
• add optional fields to requests,
• add values to enums that are documented as open (destination types, scan properties).

Write clients that ignore unknown fields and unknown enum values. Anything that would break a correct client, such as removing a field or changing its type, ships as a new major version, with at least three months of overlap during which both versions work, announced here.

ChangelogCopy Anchor Link

2026-10-19Copy Anchor Link

• POST /v1/design/preview takes an optional logo, in the same shape as POST /v1/codes, so a preview shows the centre logo before anything is saved. A previewed logo is not added to the Library; saving a code with it is what adds it.
• GET /v1/templates?images=wordless returns KuikCode's own templates with a picture that leaves out the words in their frame and centre, for screens that show each name as text next to it. Saved templates keep their own picture.

2026-10-02Copy Anchor Link

• The page builder's block plan reports basic where it reported free: the lowest tier is now the Basic plan's link-in-bio set (Header, Buttons, Socials, Rich text, Heading, Image, Divider, Map).
• Guest uploads, Music link and Review funnel blocks report pro; Form reports core (it reported pro), and Guest uploads reported core before. A form's webhookUrl needs PRO (it needed Business).
• Saving a page on a plan that lacks one of its blocks keeps working for blocks the page already has; only adding one is refused (403). Publishing still requires every block to be on the plan.

2026-10-01Copy Anchor Link

• workspace.plan on GET /v1/me gains basic and core, and starter becomes core. No workspace was on Starter, since plans could not be bought during the beta.
• The page builder's block plan reports core where it reported starter.

2026-09-28Copy Anchor Link

• Scan.code gains name, so a scan can be reported without a second lookup.
• Submission gains fields: the answers keyed by each field's label, the way form webhooks send them. data stays keyed by field id.

2026-09-26Copy Anchor Link

• Build KuikPages: GET /page-templates, POST /pages (from a curated or saved template), GET /pages/{id}/content, POST /pages/{id}/edits (edit operations guarded by the page's revision; a stale revision answers 409), POST /pages/{id}/publish, and GET /page-blocks for each block type's fields.
• Images: POST /images stores a picture from a URL or base64 in the Library; GET /stock/photos and POST /stock/photos/{id}/import search and import free stock photos.

2026-09-25Copy Anchor Link

• Hosted sites: GET /sites, GET /sites/{id}, POST /sites to publish a ZIP to {subdomain}.kuik.page, POST /sites/{id}/deploy to redeploy in place, and POST /sites/uploads to stage ZIPs over about 3 MB.
• POST /images/generate creates a picture from a text description and stores it in the Library, metered by the plan's monthly AI generated images.
• GET /me gains limits.sites, limits.aiImages, usage.sites and usage.aiImages.

2026-09-08Copy Anchor Link

• Webhook deliveries are queued and retried: up to five attempts on timeouts, 408, 425, 429 and 5xx answers, with Retry-After honored. Every attempt carries X-KuikCode-Delivery (stable per event) and X-KuikCode-Timestamp.
• New signature format: X-KuikCode-Signature: t=<unix>,v1=<hex>, the HMAC-SHA256 of <t>.<body>. The previous sha256=<hex> form is no longer sent; update your verifier before deploying codes with webhooks.
• GET /webhooks/deliveries, GET /webhooks/{id}/deliveries and POST /webhooks/deliveries/{deliveryId}/retry expose the delivery history.
• POST /webhooks/{id}/secret reveals the secret and POST /webhooks/{id}/rotate-secret rotates it with a 24-hour overlap. Plain GET /webhooks and GET /webhooks/{id} no longer include secret.
• Webhook gains enabled and secretRotatedAt; PATCH /webhooks/{id} accepts enabled to pause and resume delivery.

2026-09-06Copy Anchor Link

• Initial release of v1: workspace (/me), codes with designed artwork download, folders, templates, scans and analytics, form submissions, webhooks and read-only KuikPages.