Loading pattern preview
Loading preview…
PatternsSDK API
HIL Tool Approval Basic
HIL Tool Approval Basic
Chat assistant with human approval workflows for safe tool execution.
Loading pattern preview
Loading preview…
Problems solved
Technical challenges this implementation handles out of the box.
- Intercept tool calls that require human confirmation before execution
- Resume the agent after approve or deny decisions
- Limit agent loops with stepCountIs during approval flows
- Surface pending tool approvals in a streaming chat UI
Use cases
Products and workflows this pattern is designed to support.
- Content moderation queues with human sign-off
- E-commerce actions that need cart confirmation
- Admin tools that gate destructive operations
- Customer-support agents requiring human approval
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
Install from the preview toolbar
Copy the install command above and run it in your project — Pro patterns include a short-lived token.
- 2
Add environment variables to .env.local
OPENAI_API_KEY, UPSTASH_REDIS_REST_URL, UPSTASH_REDIS_REST_TOKEN
- 3
Point client fetches at your API routes
Replace preview `/view/.../api/...` paths with `/api/...` in the installed files.
- 4
Customize the agent and tool files
Adapt prompts, tools, and stop conditions for your product — Copy for AI in the toolbar helps seed that work.
- 5
Run your dev server and open the pattern route
Install dependencies if needed, then start the app and verify responses.
Environment variables
Capabilities
AI SDK APIs
streamTextgatewaystepCountIsconvertToModelMessagestoolProviders
OpenAI
External services
Upstash
Files added
6 filesapp/page.tsxapp/layout.tsxapp/api/human-in-loop/route.tslib/tools.tslib/utils.tsREADME.md
Dependencies
8 totalnpm packages
6AISDKlucide-reactNext.jsReactsonnerZod
Registry components
buttonempty
Critical files
human-in-loop/route.tsAPI route implementing the human-in-the-loop pattern. Uses processToolCalls() to intercept tool calls that require human confirmation before execution. Passes executor functions for tools without execute. Uses stepCountIs(5) to limit agent loops.
lib/tools.tsDefines 7 AI tools demonstrating the human-in-the-loop pattern. 5 tools lack execute functions (requiring human approval): getWeatherInformation, moderateContent, addToCart, approveUser, processPayment. 2 tools have execute functions (auto-execute): webSearch, getLocalTime.
lib/utils.tsCore utility implementing the processToolCalls pattern for human-in-the-loop flows. Processes tool parts from the last message, checks for APPROVAL.YES/NO strings, executes approved tools via provided executor functions, and streams results back via UIMessageStreamWriter.
Requirements
- Complexity
- Intermediate
- Setup time
- ~15 minutes
- Node
- 24+
- Memory
- 512MB
