Kalpana Docs

Kalpana Designer has 47 tools. Agents receive each tool's JSON Schema from tools/list; these pages document the same arguments for people.

page_id is the page a design tool works on; create_design returns it and list_pages lists a template's pages. template_id is the template, which the batch server takes as templateId.
intent: every tool that changes a design takes one short sentence of what changes and why, kept in the design's history.
Units: positions and sizes are px in the page, relative to the parent layer; times are seconds from the start of the page's timeline; angles are degrees, clockwise.
Unknown fields are refused, and the error lists the valid ones. Types such as fill, flow and layer are on Shared types.
Cost: see Credits.

Templates and pages

Read the guide and the workspace, find templates, and manage a template's pages and details.

Tool	Changes the design	Cost	What it does
`design_guide`	No	Free	How designs, layers, inputs and the tools fit together.
`get_workspace`	No	Free	The connected workspace, whether its plan is active, and the domains image URLs may come from.
`search_templates`	No	Free	The workspace's templates, newest first or by query, with previews.
`list_pages`	No	Free	A template's pages and their ids.
`rename_page`	Renames	Free	Rename one page.
`delete_pages`	Deletes	Free	Delete one or more pages; they cannot be brought back.
`duplicate`	Adds pages	Free	Copy pages into a template or a new one, optionally at a new size.
`set_template_info`	Saves	Free	Name and describe the template and its inputs, and save it.
`undo`	Yes	Free	Revert a design's latest change.
`send_feedback`	No	Free	Tell Kalpana what in the tools or guide got in the way.

Create a page and build, read, change and delete its layers.

Tool	Changes the design	Cost	What it does
`create_design`	Creates	Paid	A new page at a given size and background.
`create_layers`	Yes	Paid	Add a whole layer tree in one call.
`update_layers`	Yes	Paid	Change many existing layers in one call.
`edit_structure`	Yes	Paid	Move, copy, wrap, mask, combine, scale, align and distribute layers.
`delete_layers`	Deletes	Paid	Delete layers and everything inside them.
`get_design`	No	Free (paid with `with_preview`)	Every layer with its laid-out box, text, colours, flow and etag.
`import_svg`	Yes	Paid	Add an SVG as editable vector layers in one group.
`make_chart`	Yes	Paid	A chart from numbers, as editable layers.

What a design may use: the workspace's fonts and images, the user's uploads and shader fills.

Tool	Changes the design	Cost	What it does
`list_fonts`	No	Free	Font families and styles the workspace may use.
`find_images`	No	Free list, paid preview sheet	The workspace's images, by collection or file name, with a preview sheet.
`upload_images`	No	Free	Bring the user's own images into the workspace.
`list_shaders`	No	Free	Procedural shader fills and their settings.

Check a design, preview it, and compute numbers, text sizes, paths and positions instead of guessing.

Tool	Changes the design	Cost	What it does
`check_layout`	No	Free	Overlapping text, cut-off layers, small text and low contrast.
`render_design`	No	Paid	A preview PNG, zoomed to a layer, region or moment.
`calculate`	No	Free	Exact arithmetic.
`measure_text`	No	Free	Real text size, or the largest size that fits a box.
`shape_path`	No	Free	Exact SVG path data for shapes.
`place_items`	No	Free	Positions for items on a circle, arc, grid, line or path.

Animate layers, set the timeline and check motion as frames.

Tool	Changes the design	Cost	What it does
`animate`	Yes	Paid	Motion presets, keyframes, text reveals, morphs and staggers.
`kinetic_type`	Yes	Paid	A phrase set word by word with motion.
`make_transition`	Yes	Paid	Circle, stripe, blade and burst transitions.
`camera`	Yes	Paid	A camera move across the design.
`make_particles`	Yes	Paid	A field of small shapes with motion.
`make_cursor`	Yes	Paid	A pointer that glides and clicks.
`make_list`	Yes	Paid	Rows of UI that spring in, with a moving highlight.
`make_carousel`	Yes	Paid	Cards on a 3D track inside one design.
`stagger_times`	No	Free	Start times for a cascade.
`set_timeline`	Yes	Paid	Length, frame rate and still time.
`set_choreography`	Yes	Paid	Camera moves and morphs between layers.
`edit_keyframes`	Yes	Paid	Add, move, change or delete single keyframes.
`clear_animation`	Yes	Paid	Remove motion from layers or the whole page.
`render_timeline`	No	Paid	The timeline drawn as a diagram.
`render_contact_sheet`	No	Paid	Frames of the animation tiled in one PNG.

Join some of a template's pages into one video, with a transition into each page.

Tool	Changes the design	Cost	What it does
`list_flows`	No	Free	A template's flows, each joining some of its pages into one video.
`create_flow`	Yes	Free	Add a flow: pages in order, with the transition into each.
`update_flow`	Yes	Free	Change a flow's name, size or steps.
`delete_flow`	Deletes	Free	Delete a flow; its pages stay.