API Parameter
Expose parameters for runtime customization via API
API Parameter
Expose parameters for runtime customization via API
Overview
The API Parameter node creates a dynamic input that can be provided when executing the pipeline via API. Use it to make pipelines configurable - callers can provide text, numbers, colors, sizes, or URLs at runtime.
Usage Tips
- Choose a descriptive key name for API documentation
- Set appropriate data type: text, number, color, size, url
- Provide sensible default values for optional parameters
- Document expected values in your pipeline description
Common Pairings
- Text - Dynamic text content for watermarks
- Import from URL - Dynamic image sources
- Adjust HSV - Configurable color adjustments
Gotchas
- API callers must use the exact key name you specify
- Data type must match the connected node’s expected input
- Pipelines with API nodes are designed for programmatic access
Technical Reference
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
params_key | text | my_param | Parameter key name for API access |
params_data_type | text | text | Data type: text, number, color, size, url |