Completion type that marks the workflow as finished. Successful by default, but can be configured to cancel instead, optionally with a reason. Written as the end element inside a step's completion.

Group: AI Agents

Implements: AgentWorkflowStepCompletionType


Properties

PropertyReturnsDescription
cancelbooleanWhether completing this step cancels the workflow rather than finishing it successfully.
reasonStringFree-text explanation for why the workflow was cancelled.

Methods

isCancel()

Returns: boolean

Whether completing this step cancels the workflow rather than finishing it successfully.

getReason()

Returns: String

Free-text explanation for why the workflow was cancelled.

To get full access to the Kademi Hub existing customers can login here, or new customers can register here.