Get Better Widget Guide
get-widget-guideReturns a build brief for an interactive widget on an article or landing page, such as a calculator, estimator, converter, quiz or checklist. Pass what is known about the widget. The response lists any details still missing, and once the details are complete it returns the brief with rules for calculation accuracy, form behavior, search visibility, performance and privacy. With format: "page-family" it returns a brief for a family of pages built from the rows of a dataset, such as a CSV or a database table.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| format | No | What to build: one widget (the default), or a page family, meaning one page for each row of a dataset such as a CSV or a database table. | |
| inputs | No | Required inputs, including units, allowed ranges, and defaults. | |
| result | No | What the result shows, explains, and lets the user do next. | |
| userGoal | No | Who will use the widget or read each page, and the decision or task it helps them complete. | |
| maxTokens | No | Maximum tokens to return. Truncates content to fit. Recommended: 5000-10000. | |
| dataSource | No | Page family: where the rows live, such as a CSV path or a table, and about how many rows there are. | |
| urlPattern | No | Page family: the route and slug rule, such as /integrations/[slug]. | |
| widgetType | No | Widget kind: calculator, estimator, converter, generator, quiz, or checklist. | |
| interaction | No | How readers tune inputs and see feedback, including presets, custom controls, direct manipulation, and exact-value entry. | |
| uniqueValue | No | Page family: what each page gives a reader that only its row provides, such as its data or a widget filled with its values. | |
| hostFramework | No | The host framework and the page or component that will contain the widget. | |
| visualContext | No | Existing design tokens, components, or brand reference the widget must match. | |
| transformation | No | Formula, scoring rule, conversion, or transformation that produces the result. |