Loading pattern preview
BlocksHuman-in-the-Loop
Tool Approval
Tool Approval
Demonstrate tool execution with user confirmation. Includes approval workflows, confirmation UI, and state management for safe AI operations.
Use 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.
Loading pattern preview
Problems solved
Technical challenges this implementation handles out of the box.
- Require user confirmation before a needsApproval tool runs
- Demonstrate the AI SDK built-in approval mechanism for delete_file
- Keep pending approval state visible in the chat UI
Use cases
Products and workflows this pattern is designed to support.
- File-deletion confirmations in assistants
- Destructive admin actions gated by the user
- Teaching needsApproval tool flows
- Safe tool execution demos
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.
HIL Needs ApprovalDemonstrate tool approval with async generators. Includes real-time feedback, approval workflows, and interactive management.
Tool ExecutionUse this when your chat app calls tools and you want each call's input, output, and status rendered inline as it streams.
Task Management DemoUse this when you need the model to stream a schema-validated list of tasks and show them in an interactive task UI as they arrive.
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: OPENAI_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
OPENAI_API_KEYGet key
Capabilities
AI SDK APIs
streamTextconvertToModelMessagesuseChataddToolApprovalResponseProviders
OpenAI
Files added
4 files
app/page.tsxapp/layout.tsxcomponents/chat-form.tsxapp/api/ai-elements-confirmation/route.ts
Dependencies
9 total
npm packages
5AISDKlucide-reactNext.jsReactZod
Registry components
buttonconfirmationemptytooltip
Critical files
1 file
ai-elements-confirmation/route.tsAPI route demonstrating the needsApproval tool pattern. Defines a delete_file tool with needsApproval: true that requires user confirmation before execution. Shows the built-in AI SDK approval mechanism.
Requirements
- Complexity
- Beginner
- Setup time
- ~10 minutes
- Node
- 24+
- Memory
- 512MB
