The quickstart

Three steps: get a key, install the SDK, render a design. Or skip the SDK and hit the REST endpoint directly.

// Install
npm install @koalaful/sdk

// Render a design from a template
import { Koalaful } from '@koalaful/sdk';

const koalaful = new Koalaful({ apiKey: process.env.KOALAFUL_KEY });

const design = await koalaful.designs.create({
  template: "spring-sale-ig",
  variables: {
    headline:  "Spring Sale",
    discount:  "40% off",
    dates:     "Apr 15 — 30",
  },
  format: "png",
});

console.log(design.url);
// → https://cdn.koalaful.io/render/sQ9...png

What you can do

Create from templates

Pass variables, get a rendered design back as PNG, JPG, PDF, or SVG. Cache control headers included.

Edit existing designs

Update text, images, or any data-variable field on a saved design without re-rendering from scratch.

Bulk personalisation

Submit a CSV or JSON array of variable maps. One request, thousands of rendered variants. Built for direct mail, sales campaigns, and personalised content at scale.

List and fetch

Paginate through designs, fetch one by ID, get its current rendered URL.

Templates and assets

Query available templates, inspect their variable schemas, list your uploaded assets and brand kits.

MCP server

Drop the KoalaFul MCP server into your own AI agent (Claude, Cursor, custom Anthropic/OpenAI tools) and let it design too. Same auth, same endpoints — just exposed as MCP tools.

Pricing tiers

Overages on the metered plans are billed at $0.002 / render after your monthly allowance.

Auth and safety

Bearer-token authentication. Server-side keys only — never expose a key in client code. Webhook signatures use HMAC-SHA256. CORS is locked down to API endpoints; the editor is on a separate origin.

curl https://api.koalaful.io/v1/designs \
  -H "Authorization: Bearer $KOALAFUL_KEY" \
  -H "Content-Type: application/json" \
  -d '{"template":"spring-sale-ig","variables":{"headline":"Spring Sale"}}'