Subcategory
11 patterns

tool( )

AI SDK tool API examples and patterns

Part of SDK API

HIL Tool Approval Basic preview
INT

HIL Tool Approval Basic

Chat assistant with human approval workflows for safe tool execution.

aihuman-in-the-loop+6
View →
HIL Needs Approval preview
INT

HIL Needs Approval

Demonstrate tool approval with async generators. Includes real-time feedback, approval workflows, and interactive management.

aiagents+8
View →
Tool Input Lifecycle Hooks preview
BEG

Tool Input Lifecycle Hooks

Explore tool input lifecycle hooks: onInputStart, onInputDelta, and onInputAvailable. See how to track tool input generation in real-time during streaming.

aitools+7
View →
Preliminary Tool Results preview
BEG

Preliminary Tool Results

Return preliminary tool results using async iterables. Stream status updates during tool execution before the final result is available.

aitools+6
View →
Tool API Context preview
BEG

Tool API Context

Pass arbitrary context from generateText/streamText to tool execution via experimental_context. Access context in tool execute functions for dynamic behavior.

aitools+5
View →
Tool Call Repair preview
INT

Tool Call Repair

Repair invalid tool calls using experimental_repairToolCall. Fix schema validation errors without requiring additional steps that pollute message history.

aitools+6
View →
Dynamic Tool preview
INT

Dynamic Tool

Create dynamic tools with runtime-generated schemas using dynamicTool. Demonstrates unit conversion tools where schema adapts based on conversion type (temperature, length, weight, currency) and supports dynamic model selection.

aitools+8
View →
Search - Exa AI (robust) preview

Search - Exa AI (robust)

Search the web using Exa's semantic API and real-time crawling. Includes URL search, content extraction, Wikipedia, Reddit, and news search tools.

aisearch+6
View →
Search - Firecrawl (robust) preview

Search - Firecrawl (robust)

Search the web using Firecrawl's API and real-time crawling. Includes URL search, content extraction, Wikipedia, Reddit, and news search tools.

aisearch+6
View →
Scrape - Cheerio (lightweight) preview

Scrape - Cheerio (lightweight)

Scrape websites using Cheerio's fast HTML parser. Includes URL scraping, website crawling, and content extraction without external API costs.

aiscrape+8
View →
Scrape - Jina AI (advanced) preview

Scrape - Jina AI (advanced)

Scrape websites using Jina AI's reader service with JavaScript rendering. Includes URL scraping, website crawling, and content extraction with AI-powered parsing.

aiscrape+8
Jina Elastic icon
View →

Explore More

More in SDK API

generateText( )

Text and structured data generation with Output.object()

streamText( )

Streaming text and structured data with Output.object()

generateImage( )

Image generation examples

generateSpeech( )

Speech synthesis examples

transcribe( )

Audio transcription examples

Agent( )

AI SDK agent API examples and patterns

End of tool( )