Loading pattern preview
BlocksHuman-in-the-Loop
HIL Needs Approval
HIL Needs Approval
Demonstrate tool approval with async generators. Includes real-time feedback, approval workflows, and interactive management.
Loading pattern preview
Problems solved
Technical challenges this implementation handles out of the box.
- Pause Experimental_Agent tool calls until the user approves
- Handle approval denial gracefully in agent instructions
- Visualize pending and completed tool execution states
- Stream approval UI updates during the agent loop
Use cases
Products and workflows this pattern is designed to support.
- Sensitive tool actions that need sign-off
- Admin agents gating writes and deletes
- Customer-support agents requiring human approval
- Educational demos of needsApproval agent flows
Compare with
Similar patterns, and when each one is the better fit.
HIL Tool Approval BasicUse this when you want a basic starting point for gating risky agent tool calls behind a human approve or deny step, with Upstash in the stack.
Tool ApprovalUse this when a destructive action, such as deleting a file, needs an in-chat confirm or deny step built only on the AI SDK's own approval flow.
HIL Inquire Multiple ChoiceUse this when an agent loop must stop on an inquire tool call to collect a multiple-choice answer before continuing with that context.
HIL Inquire Text InputUse this when your agent needs to pause mid-loop, ask the user an open-ended question, and resume once they type a free-text answer.
Setup
Requirements, wiring steps, and what this pattern adds to your project.
Getting started
Pick how you want to pull this pattern in. Then wire env vars and routes the same way.
- 1
Download → Next.js app
Use Download → Next.js app in the preview toolbar. You get a zip scaffold (Pro downloads rewrite preview `/view/.../api/*` paths to `/api/*` automatically).
- 2
Extract the zip and install dependencies
Unzip the archive, then run `pnpm install` (or npm / yarn) in the project folder.
- 3
Fill .env.local
The download includes .env.local placeholders when needed. Add real values for: GOOGLE_AI_API_KEY.
- 4
Customize the agent and tool files
Adapt prompts, tools, and stop conditions in the generated project for your product.
- 5
Run the app and open the pattern route
Run `pnpm dev`, open the setup/checklist page if present, then navigate to the generated pattern route and verify responses.
Environment variables
GOOGLE_AI_API_KEYGet key
Capabilities
AI SDK APIs
AgenttoolstepCountIsExperimental_AgentgatewayUIToolInvocationProviders
Gemini
External services
Upstash
Files added
11 files
app/page.tsxapp/layout.tsxapp/api/tool-approval/route.tslib/tool-approval-agent.tslib/tool-approval-types.tslib/tools/weather-tool.tslib/tools/schema.tscomponents/tool-approval-chat.tsxcomponents/tool-views/weather-with-approval-view.tsxREADME.mdAGENT_FLOW.md
Dependencies
8 total
npm packages
6AISDKlucide-reactNext.jsReactsonnerZod
Registry components
buttonempty
Critical files
2 files
lib/tool-approval-agent.tsAgent definition using Experimental_Agent with tool approval pattern. Configures instructions to handle approval denial gracefully.
tools/weather-tool.tsWeather tool with needsApproval: true — the key pattern for human-in-the-loop tool approval. Uses generator pattern with yield for loading/ready states.
Requirements
- Complexity
- Intermediate
- Setup time
- ~15 minutes
- Node
- 24+
- Memory
- 512MB
Upstash Redis
