Step

ParameterTypeDefaultDescription
nameOptional[str]NoneName of the step for identification
agentOptional[Agent]NoneAgent to execute for this step
teamOptional[Team]NoneTeam to execute for this step
executorOptional[StepExecutor]NoneCustom function to execute for this step
step_idOptional[str]NoneUnique identifier for the step (auto-generated if not provided)
descriptionOptional[str]NoneDescription of the step's purpose
max_retriesint3Maximum number of retry attempts on failure
timeout_secondsOptional[int]NoneTimeout for step execution in seconds
skip_on_failureboolFalseWhether to skip this step if it fails after all retries
add_workflow_historyboolFalseIf True, add the workflow history to the step
num_history_runsintNoneNumber of runs to include in the workflow history, if not provided, all history runs are included
human_reviewOptional[HumanReview]NoneAll HITL settings in a single config. Equivalent to passing the flat fields below. See HumanReview Config.
requires_confirmationboolFalsePause for user confirmation before execution
confirmation_messageOptional[str]NoneMessage shown to user when requesting confirmation
requires_user_inputboolFalsePause to collect user input before execution
user_input_messageOptional[str]NoneMessage shown to user when requesting input
user_input_schemaOptional[List[UserInputField]]NoneSchema defining expected input fields
requires_output_reviewUnion[bool, Callable[[StepOutput], bool]]FalsePause after execution to review the step's output. See Output Review.
output_review_messageOptional[str]NoneMessage shown to user during output review
hitl_max_retriesint3Max re-executions when an output review is rejected with OnReject.retry
hitl_timeoutOptional[int]NoneSeconds before the HITL pause auto-resolves. See Timeout.
on_timeoutUnion[OnTimeout, str]OnTimeout.cancelAction when the HITL timeout expires: approve, reject, cancel
on_rejectOnRejectOnReject.skipAction when rejected: skip, cancel, retry
on_errorOnErrorOnError.failAction on error: fail, skip, pause

When the step's agent or team calls a tool decorated with @tool(requires_confirmation=True), requires_user_input=True, or external_execution=True, the workflow pauses with pause_kind="executor". See Executor HITL.