@loopstack/hitl-ask-user-example-workflow

Demonstrates how to prompt the user for free-text input from inside a workflow using the AskUserWorkflow from @loopstack/hitl. The user’s answer is captured and echoed back as an assistant message.

By using this example you’ll get…

A parent workflow that launches AskUserWorkflow as a sub-workflow with a callback
A concrete pattern for waiting on human input without blocking the worker
An AskUserDocument rendered in the UI while the workflow is paused

Installation


npm install @loopstack/hitl-ask-user-example-workflow

The package depends on @loopstack/hitl.

How It Works

The workflow starts and calls AskUserWorkflow.run({ question }) as a sub-workflow.
The sub-workflow renders an AskUserDocument and stops at waiting_for_user.
When the user submits an answer, the sub-workflow finishes and the parent’s callback fires.
The parent saves a MessageDocument with the answer and ends.

Public API

HitlAskUserExampleModule
HitlAskUserExampleWorkflow

Dependencies

@loopstack/common
@loopstack/hitl