Paramlet for developers and AI agents

Every Paramlet generator can be driven without scraping the page or touching its DOM. This page documents API version 1. Version 1 only grows: new optional fields may be added, but existing names and meanings stay. A breaking change would be published as version 2 alongside it.

Generators

Tool idPageSchemaDescription
soft-plastic-lure/tools/soft-plastic-lure/schema.jsonPrintable two-part plastisol molds for soft plastic lures (five lure types). Output: 3MF or STL, millimetres. presets.json

Parameter schema

Each generator publishes a JSON Schema (draft 2020-12) of all its parameters at /tools/<tool>/schema.json: name, title, unit (x-unit), minimum, maximum, step, default and allowed values (enum). The step is multipleOf for whole-number steps and x-step for decimal ones (counted from minimum; values are snapped to it), so standard validators such as ajv accept every valid value. The schema sets additionalProperties: false; anything not listed is rejected. Lengths are millimetres, angles degrees, × is a ratio and on/off switches are 0 or 1.

Lure types (presets)

lureFamily is one of paddle_shad (default), stick, twister, craw and grub_worm. The values each type sets are in the schema under x-presets and in presets.json. In the page, choosing a type resets every lure-shape value to its default and then applies the preset; mold, download and view settings are kept. Through the API, setParams applies exactly what you send, so send the preset values together with lureFamily (e.g. with reset: true).

Values are always millimetres. units (mm / in) only changes what the controls show.

Open a generator with settings already applied. Only changed parameters are needed; everything else keeps its default.

https://paramlet.com/tools/soft-plastic-lure/?L=100&tailType=paddle&mold=1
https://paramlet.com/tools/soft-plastic-lure/?p=%7B%22L%22%3A100%2C%22tailType%22%3A%22paddle%22%7D
https://paramlet.com/tools/soft-plastic-lure/#p=eyJMIjoxMDAsInRhaWxUeXBlIjoicGFkZGxlIn0
https://paramlet.com/tools/soft-plastic-lure/#project=<base64url project JSON>

Project files

“Save project” downloads a *.paramlet.json file; “Open project” reads one. The same object works in deep links (without a photo) and in window.paramlet.loadProject().

{
 "format": "paramlet.project",
 "schemaVersion": 1,
 "tool": "soft-plastic-lure",
 "toolVersion": "1.0.0",
 "name": "Paddle 10 cm",
 "created": "2026-11-20T10:00:00.000Z",
 "modified": "2026-11-20T10:05:00.000Z",
 "params": { "L": 100, "tailType": "paddle", "mold": 1 },
 "photo": { "dataUrl": "data:image/jpeg;base64,…" }
}

window.paramlet

A frozen object on every generator page. All methods are safe to call: they validate input and never give access to the download quota or other internals.

paramlet.version            // "1"
paramlet.tool               // "soft-plastic-lure"
paramlet.getSchema()        // the JSON Schema
paramlet.getParams()        // all current parameters
paramlet.getState()         // size in mm, volume, mold, warnings, changed params, share URL
paramlet.getProject({ includePhoto: false })
await paramlet.setParams({ L: 100, tailType: "paddle" })            // { ok: true, state } or { ok: false, errors }
await paramlet.setParams({ L: 100 }, { reset: true })               // start from defaults
await paramlet.loadProject(projectObjectOrJsonString)                // { ok, state } or { ok: false, errors }
await paramlet.exportModel({ format: "3mf", tol: 0.02 })            // { ok, status, filename, bytes }
await paramlet.exportSTL()                                          // STL files in a zip
await paramlet.export3MF()

setParams applies everything or nothing: one unknown key or out-of-range value rejects the call. Exports take the same download path as the Download button, which applies the current plan’s limits; at launch there are none. status is free, ad, cancelled, blocked or error. Only one export runs at a time, and calls are rate-limited. Export types 3mf and stl are available; master (positive bait for a silicone mold), cnc_mold (STEP for an aluminium mold) and 2d_template (SVG / DXF / PDF) are reserved names and are refused for now.

WebMCP

In browsers that support WebMCP (document.modelContext), the lure page registers these tools. They call the same functions as window.paramlet.

ToolDoes
lure_get_parameter_schemaReturns the JSON Schema.
lure_get_stateReturns the current lure.
lure_set_parameters{ params, reset? } → validated update.
lure_load_project{ project } → opens a project object.
lure_download{ format?, tol? } → gated model download.

Validation and limits

Also available: llms.txt and a Markdown description of each tool, e.g. soft-plastic-lure/index.md.