POST a small JSON description and get back a deck-ready PNG (or SVG). The endpoint is open and CORS-enabled, so it works from browsers, scripts, CI and anywhere else you can make an HTTP call. The same JSON opens in the builder.
| Field | Type | Description |
|---|---|---|
| title | string | Heading shown top-left of the chart at 22px bold. Every chart has one title row; an empty string hides it. max 140 chars · default "Pyramid" |
| width | integer | Chart width in pixels (640–2400, default 1280, which suits a 16:9 slide). PNG output renders at 2x. Height is always computed from the content. 640–2400 · default 1280 |
| palette | string[] | Hex colours applied in order to items that have no colour of their own. Pass the user's brand colours here when they name them. Default: indigo, sky, emerald, amber, red, gray. max 12 items · default ["#4f46e5","#0ea5e9","#10b981","#f59e0b","#ef4444","#6b7280"] |
| mode | string | "pyramid" (default) narrows toward the top layer, for hierarchies and foundations-to-vision stacks. "funnel" is widest at the top and narrows down, for sales, marketing and hiring stages. Layers are always listed top to bottom. "pyramid", "funnel" · default "pyramid" |
| layersrequired | object[] | The layers, top to bottom (2–8; extra layers are dropped with a warning). In a pyramid the first layer is the narrow tip; in a funnel it is the wide first stage. Names sit inside the shape when they fit, otherwise beside it with a leader line. max 8 items |
| Field | Type | Description |
|---|---|---|
| namerequired | string | Layer label, e.g. "Leads" or "Self-actualisation". One to four words read best. max 60 chars |
| detail | string | Optional short description shown in a muted column to the right of the shape, aligned to this layer. Wraps to two lines. max 160 chars |
| color | string | Hex colour for this layer, e.g. "#4f46e5". Optional: layers without one take the next palette colour. The label switches between white and dark for contrast. max 40 chars |
POST /api/render/pyramid returns image/png; add ?format=svg for SVG.GET /pyramid.png?d=<payload> and /pyramid.svg?d=<payload> render a chart from a link. The payload is the JSON body, raw-deflated and base64url-encoded. Nothing is stored: links are permanent and cached for a year./pyramid#d=<payload> opens the same chart in the builder for editing.GET /api/render/pyramid?demo=1 returns the demo chart.GET /api/schema/pyramid returns the JSON Schema, for code generators and AIs.Input is lenient where the intent is clear: numeric strings become numbers, out-of-range values are clamped, and unknown fields are ignored. Adjustments are listed in the X-Render-Warnings header. Anything unclear returns a 400 that says how to fix it:
{
"error": "Invalid payload",
"issues": [{ "path": "tasks", "message": "must be an array" }],
"example": { … }
}
Use the hosted MCP server instead. It gives Claude, Cursor and other MCP clients a create_pyramid tool that returns the image plus image, SVG and edit links. See the MCP page →