ParameterTypeDefaultDescription
idOptional[str]NoneUnique identifier for the workflow (auto-generated if not set)
nameOptional[str]NoneName of the workflow for identification
descriptionOptional[str]NoneDescription of the workflow's purpose
dbOptional[BaseDb]NoneDatabase backend for persisting workflow data
stepsOptional[WorkflowSteps]NoneSteps to execute in the workflow
session_idOptional[str]NoneSession UUID for tracking workflow execution (auto-generated if not set)
session_stateOptional[Dict[str, Any]]NoneState data for the workflow session (stored in database to persist across runs)
user_idOptional[str]NoneID of the user executing the workflow
debug_modeOptional[bool]FalseEnable debug mode for detailed logging
streamOptional[bool]NoneStream the response from the workflow
stream_intermediate_stepsboolFalseStream intermediate steps during execution
store_eventsboolFalseStore execution events for debugging/auditing
events_to_skipOptional[List[WorkflowRunEvent]]NoneList of event types to skip when storing
store_executor_outputsboolTrueControl whether to store executor responses (agent/team responses) in flattened runs
input_schemaOptional[Type[BaseModel]]NoneInput schema to validate the input to the workflow
metadataOptional[Dict[str, Any]]NoneMetadata stored with this workflow
cache_sessionboolFalseWhether to cache the workflow session
telemetryboolTrueEnable telemetry for analytics