Connecting to dev server...

Circuitry Logo
Circuitry
Open Editor

Params Node

The Params node provides adjustable controls (sliders, toggles, number inputs) for fine-tuning workflow behavior without editing code. Perfect for creating interactive workflows with real-time parameter adjustments.

Overview

The Params node allows you to:

  • Create visual controls for workflow parameters
  • Adjust values in real-time with sliders and toggles
  • Automatically trigger downstream nodes with Live Update mode
  • Pass parameter values to other nodes via template syntax
  • Switch between visual controls and JSON configuration

Common Use Cases

🎨 Visual Effects & Image Processing

Adjust filters, effects, and transformations in real-time.

Example: Image filter controls

Image → Params (brightness, contrast, saturation) → Code → Display
         ⚡ Live Update ON

⚙️ API Configuration

Fine-tune API request parameters without editing nodes.

Example: Search API settings

Query → Params (limit, offset, sort) → HTTP Request → Results

🤖 AI Model Tuning

Dynamically adjust AI model parameters.

Example: Agent configuration

Input → Params (temperature, max_tokens) → Agent → Response

📊 Chart & Visualization Controls

Interactively adjust visualization parameters.

Example: Chart customization

Data → Params (chart_type, colors, size) → Chart → Display
       ⚡ Live Update ON

Configuration

Parameter Types

Slider

Visual range control for numeric values.

Example:

{
  "name": "opacity",
  "label": "Opacity",
  "type": "slider",
  "min": 0,
  "max": 100,
  "step": 1,
  "defaultValue": 100,
  "unit": "%"
}

Number Input

Precise numeric input with validation.

Example:

{
  "name": "timeout",
  "label": "Timeout",
  "type": "number",
  "min": 100,
  "max": 30000,
  "step": 100,
  "defaultValue": 5000,
  "unit": "ms"
}

Toggle

On/off switch for boolean values.

Example:

{
  "name": "enabled",
  "label": "Enable Feature",
  "type": "toggle",
  "defaultValue": true
}

Live Update Mode ⚡

The Live Update toggle automatically runs downstream nodes when you change parameters.

How it works:

  1. Click the ⚡ icon in the node header (turns amber when active)
  2. Adjust any parameter value
  3. Downstream nodes execute automatically with new values

Best for:

  • ✅ Image processing (instant preview)
  • ✅ Chart visualization (dynamic tuning)
  • ✅ Data transformations (immediate feedback)
  • ✅ Simple HTTP requests

Not available for:

  • ❌ Agent nodes - Prevented to avoid unexpected AI costs
  • ❌ Chat nodes - Requires manual execution

If you adjust parameters with Live Update enabled and an Agent/Chat node is downstream, you'll see a warning message. The parameter values still update—only auto-execution is blocked.

Working with the Params Node

Compact Mode

  • Shows parameter count
  • Double-click to expand

Detail Mode - Slider UI

  • Interactive controls for each parameter
  • Real-time value display
  • Live update toggle
  • Parameter labels and descriptions

Detail Mode - JSON Editor

  • Edit parameter configurations
  • Add/remove/modify parameters
  • JSON syntax validation

Toolbar Buttons

  • ▶️ Run: Execute this node and downstream nodes
  • ⚡ Live Update: Toggle automatic execution on changes
  • ✨ Wizard: AI-powered parameter generation
  • JSON/Sliders: Switch between editor modes
  • ⚙️ Settings: Open configuration panel
  • ➖ Minimize: Return to compact view

Using Parameters in Workflows

Parameters are passed to downstream nodes and can be accessed using template syntax:

In Code Nodes

// Access parameters
const opacity = input.params.opacity / 100
const speed = input.params.speed

// Use in processing
if (input.params.enabled) {
  return processData(input.value, { opacity, speed })
}

In HTTP Requests

URL: https://api.example.com?limit={{params.limit}}&offset={{params.offset}}

Body:

{
  "query": "{{value}}",
  "max_results": {{params.limit}}
}

In Agent Nodes

Prompt: Process this data with creativity level {{params.temperature}}

Output Format

The Params node outputs:

{
  "value": "original input data",
  "params": {
    "opacity": 75,
    "speed": 1.5,
    "enabled": true
  }
}

You can customize the output key name from "params" in the configuration panel.

Practical Examples

Example 1: Image Filter Controls

[
  {
    "name": "brightness",
    "label": "Brightness",
    "type": "slider",
    "min": -100,
    "max": 100,
    "step": 5,
    "defaultValue": 0,
    "unit": "%"
  },
  {
    "name": "contrast",
    "label": "Contrast",
    "type": "slider",
    "min": -100,
    "max": 100,
    "step": 5,
    "defaultValue": 0,
    "unit": "%"
  }
]

Example 2: AI Model Settings

[
  {
    "name": "temperature",
    "label": "Temperature",
    "type": "slider",
    "min": 0,
    "max": 2,
    "step": 0.1,
    "defaultValue": 0.7,
    "description": "Controls response creativity"
  },
  {
    "name": "max_tokens",
    "label": "Max Tokens",
    "type": "number",
    "min": 10,
    "max": 4000,
    "step": 10,
    "defaultValue": 500
  }
]

Example 3: Animation Controls

[
  {
    "name": "speed",
    "label": "Speed",
    "type": "slider",
    "min": 0.1,
    "max": 5,
    "step": 0.1,
    "defaultValue": 1,
    "unit": "x"
  },
  {
    "name": "loop",
    "label": "Loop Animation",
    "type": "toggle",
    "defaultValue": true
  }
]

Tips & Best Practices

📌 For Clarity

  • Use descriptive labels
  • Add units to show what values represent
  • Include descriptions for complex parameters
  • Group related parameters logically

📌 For Performance

  • Keep parameter count reasonable (< 20)
  • Use Live Update sparingly (disable for expensive operations)
  • Avoid Live Update with Agent/Chat nodes (blocked anyway)
  • Set sensible min/max ranges

📌 For Usability

  • Choose appropriate step values
  • Use toggles for boolean options
  • Set meaningful default values
  • Test parameter ranges thoroughly

Keyboard Shortcuts

  • Double-click: Toggle between compact and detail view
  • JSON/Sliders button: Switch between editor modes
  • ⚡ button: Toggle Live Update mode

Troubleshooting

Parameters Not Appearing in Output

  • Check parameter definitions in JSON config
  • Verify parameter names are unique
  • Ensure default values are set

Can't Switch to Slider UI

  • Validate JSON syntax
  • Check all required fields (name, defaultValue)
  • Look for missing quotes or commas

Live Update Not Working

  • Check ⚡ icon is amber (enabled)
  • Verify no Agent/Chat nodes downstream (they block auto-execution)
  • Ensure workflow is properly connected
  • Check browser console for errors

Live Update Warning Toast

  • Appears when Agent or Chat nodes are downstream
  • These nodes require manual execution (prevents unexpected costs)
  • Parameter values still update—only auto-execution is blocked
  • Use ▶️ Run button to execute manually

Related Features

  • Code Node: Use parameters in code
  • Agent Node: Configure AI dynamically
  • HTTP Request: Parameterized API calls
  • Environment Variables: For global configuration

Quick Start

  1. Drag Params node onto canvas
  2. Double-click to expand
  3. Edit JSON to define parameters OR use Params Wizard (✨)
  4. Switch to Slider UI to adjust values
  5. Connect to downstream nodes
  6. Enable ⚡ Live Update for real-time changes (if no Agent/Chat downstream)
  7. Run workflow to see parameters in action

Next Steps