Parameter | Type | Default | Description |
---|---|---|---|
id | Optional[str] | None | Unique identifier for the workflow (auto-generated if not set) |
name | Optional[str] | None | Name of the workflow for identification |
description | Optional[str] | None | Description of the workflow's purpose |
db | Optional[BaseDb] | None | Database backend for persisting workflow data |
steps | Optional[WorkflowSteps] | None | Steps to execute in the workflow |
session_id | Optional[str] | None | Session UUID for tracking workflow execution (auto-generated if not set) |
session_state | Optional[Dict[str, Any]] | None | State data for the workflow session (stored in database to persist across runs) |
user_id | Optional[str] | None | ID of the user executing the workflow |
debug_mode | Optional[bool] | False | Enable debug mode for detailed logging |
stream | Optional[bool] | None | Stream the response from the workflow |
stream_intermediate_steps | bool | False | Stream intermediate steps during execution |
store_events | bool | False | Store execution events for debugging/auditing |
events_to_skip | Optional[List[WorkflowRunEvent]] | None | List of event types to skip when storing |
store_executor_outputs | bool | True | Control whether to store executor responses (agent/team responses) in flattened runs |
input_schema | Optional[Type[BaseModel]] | None | Input schema to validate the input to the workflow |
metadata | Optional[Dict[str, Any]] | None | Metadata stored with this workflow |
cache_session | bool | False | Whether to cache the workflow session |
telemetry | bool | True | Enable telemetry for analytics |