Kalpana Docs

The Kalpana REST API exposes the same workspace resources as the Studio. Use it to find a template, render files from your data, follow progress, and download the finished files.

https://app.kalpana.one/api

Looking to connect an AI agent instead? See the MCP documentation. MCP uses OAuth and a small set of guarded tools; this API uses API keys and plain HTTP.

The core flow

1. Pick a template

List templates, then read one to get its page ids and layer names.

2. Create a batch

Send one row of modifications per creative, up to 1,000 rows. Set run to true to start it.

3. Follow it

Poll the batch while its jobs render. Credits are checked before anything starts.

4. Collect files

Poll the batch, then fetch temporary download URLs.

For up to 10 files at a time, skip the batch: Create jobs with run set to true renders them and usually returns the files in the same call.

Resources

Resource	What it covers	Pages
Workspaces	List the workspaces your key can reach and read their slugs.	List, Get
Templates	Search templates, read their variables, and manage their pages.	List, Get, Summary, Update, Duplicate, Delete, Rename a page, Delete a page
Template collections	Group templates and set where each one is filed.	List, Create, Rename, Delete, Add a template, Get a template's collections, Set a template's collections
Batches	Check rows, then create, list, edit, run, cancel, and download batches.	Validate, Create, List, Get, List jobs, Update, Delete, Run, Cancel, Download
Jobs	Create up to 10 jobs at once, then inspect, edit, delete, run, and cancel them, with or without a batch.	Create, Get several, Get, Update, Delete, Run, Cancel
Creatives	List, rename, delete, and download finished files, and manage the folders they are saved in.	List, Rename, Delete, Delete several, List folders, Create a folder, Rename a folder, Delete a folder, Add to a folder, Remove from a folder, Download a folder
Assets	Search, upload, rename, and delete images, and group them in collections.	List, Search several, Upload, Upload from a URL, Upload directly, Rename, Delete, Delete several, List collections, Create a collection, Rename a collection, Delete a collection, Add to a collection, Remove from a collection, Set an asset's collections
Fonts	List and upload the fonts your templates use.	List, Upload, Upload directly
Webhooks	Get a request when files are ready.	Receiving, Overview, Event types, Status, List, Get, Create, Update, Delete, Test, Samples, Deliveries, Get a delivery, Redeliver

SDK and CLI

TypeScript SDK

Typed calls for every endpoint from Node, Bun or Deno, with retries, render waits and uploads.

CLI

Render one creative or a whole batch from a CSV with the kalpana command.

Start with Authentication and the Quickstart.

API Reference