Variable syntax
Reference a variable anywhere in a node configuration using double curly braces:{{variable_name}} token with the supplied value before the node executes.
Types of variables
Blueprint supports two kinds of variables that work together:- Runtime variables
- Environment variables
- Web UI: Fill in the variables form that appears when you click Run.
- API: Include a
variablesobject in your execute request body. - CLI: Pass a JSON string with the
--inputsflag.
OPENAI_API_KEY) and its value.
3
Reference in node configs
Use {{OPENAI_API_KEY}} in any node configuration field. The value is substituted at execution time without being exposed in the Blueprint map.
Defining variables in the editor
You can declare expected runtime variables directly on the Blueprint so the web UI knows what inputs to prompt for: 1 Open the Variables panel In the Blueprint editor, click the Variables icon in the left toolbar (or pressV).
2
Add a variable definition
Click + Add variable and fill in:
- Name — the identifier used in
{{variable_name}}syntax - Type —
string,number,boolean, orjson - Default value (optional) — used when no value is supplied at run time
- Description (optional) — shown as a hint in the run dialog
{{ inside any node configuration field to see an autocomplete list of defined variables.
Passing variables at execution time
Via the API
Include thevariables key in the request body when calling the execute endpoint:
