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 id | Page | Schema | Description |
|---|---|---|---|
soft-plastic-lure | /tools/soft-plastic-lure/ | schema.json | Printable 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.
Deep links
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>
porproject, in the query or in the hash: a parameter object or a whole project (see below), as URL-encoded JSON or base64url-encoded UTF-8 JSON.- Any other key is a single parameter, e.g.
?L=100. Lists such asbendsare given as JSON. utm_*,fbclid,gclid,msclkidandrefare ignored.- Links are limited to 8,000 characters and cannot carry a photo. If a link is invalid, nothing from it is applied and the page shows why.
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,…" }
}
paramsfollow the tool’s schema. Missing keys take their defaults; unknown keys make the file invalid.photois optional: a base64 PNG, JPEG or WebP data URL up to 6 MB. A traced shape is stored inparams.trace.- Older files (the v4 “Export versions” file or a bare parameter object) are migrated when opened. Files for another tool or from a newer schema version are refused.
- When a file is opened by hand, out-of-range values are clamped and listed. Through the API they are rejected.
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.
| Tool | Does |
|---|---|
lure_get_parameter_schema | Returns the JSON Schema. |
lure_get_state | Returns 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
- Every value from a link, the API, WebMCP or a file is checked against the schema: numbers may be given as strings (
"6,5"or"6.5"), are snapped to the step and must be inside the range; strings must be one of the allowed values; unknown keys are errors. - Size limits: project file 8 MB, photo 6 MB, link value 8,000 characters, 12 bends, 512 trace points.
- Nothing from input is ever run as code or inserted as HTML.
- All geometry runs in the visitor’s browser. There is no server API yet; a hosted endpoint, if added, will use the same schema and project format.
Also available: llms.txt and a Markdown description of each tool, e.g. soft-plastic-lure/index.md.