SDK API
Subcategory

tool( )

AI SDK tool API examples and patterns

12 patterns·SDK API
HIL Tool Approval Basic preview

HIL Tool Approval Basic

Chat assistant with human approval workflows for safe tool execution.

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

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

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

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

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

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

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 →
Scrape - Markdown.new (free) preview

Scrape - Markdown.new (free)

Scrape websites using Cloudflare's markdown.new service. Extract clean markdown content from any URL. No API key required.

aiscrape+6
View →

Explore More

Related Patterns

AI SDK Gemini Flash Text preview

AI SDK Gemini Flash Text

Generate text and analyze market research using Google's Gemini 2.5 Flash. Includes interactive charts and data visualization.

googletext-generation+8
View →
Generate Text preview

Generate Text

Generate text from prompts using AI. Simple interface with character counting and response rendering.

aiprompt+3
View →
OpenAI Structured Output preview

OpenAI Structured Output

Generate structured output from AI prompts using OpenAI. Create typed data with generateText and Output.object().

aiprompt+5
View →
Claude Structured Output preview

Claude Structured Output

Generate structured output from AI prompts using Anthropic Claude. Create typed data with generateText and Output.object().

aiprompt+6
View →
Gemini Structured Output preview

Gemini Structured Output

Generate structured output from AI prompts using Google Gemini. Create typed data with generateText and Output.object().

aiprompt+6
View →
Stream Text preview

Stream Text

Stream text responses from AI prompts in real-time. Includes character counting and live response rendering with useCompletion.

aiprompt+4
View →

More in SDK API

generateText( )

Text and structured data generation with Output.object()

5 patternsView →

streamText( )

Streaming text and structured data with Output.object()

2 patternsView →

generateImage( )

Image generation examples

3 patternsView →

generateSpeech( )

Speech synthesis examples

2 patternsView →

transcribe( )

Audio transcription examples

2 patternsView →

Agent( )

AI SDK agent API examples and patterns

2 patternsView →
End of tool( )