SDK API

Subcategory

Agent( )

AI SDK agent API examples and patterns

6 patternsSDK API
Structured Agent Output: Output.choice preview

Structured Agent Output: Output.choice

Demonstrate structured agent outputs using ToolLoopAgent with Output.choice. Constrain agent outputs to predefined choices for predictable, type-safe responses.

aiagents+5
View pattern →
Structured Agent Output: Output.array preview

Structured Agent Output: Output.array

Demonstrate structured agent outputs using ToolLoopAgent with Output.array. Returns structured array output with element schema for predictable, type-safe responses.

aiagents+5
View pattern →
Loop Control: stopWhen preview

Loop Control: stopWhen

Demonstrate ToolLoopAgent loop control with stopWhen. Covers stepCountIs, hasToolCall, combined conditions, and a custom StopCondition with step timeline visualization.

aiagents+7
View pattern →
PrepareStep: Trim Message History preview

PrepareStep: Trim Message History

Demonstrate ToolLoopAgent prepareStep for trimming long message history. Pre-seeded 24-message conversation shows context compression on the first run with per-step trim telemetry.

aiagents+6
View pattern →
Call Options: prepareCall preview

Call Options: prepareCall

Dynamically configure one ToolLoopAgent per request with callOptionsSchema and prepareCall. A customer-support agent rewrites instructions, gates tools, tunes reasoning effort, and injects RAG context based on account tier and urgency.

aiagents+7
View pattern →
Tool Context: experimental_context preview

Tool Context: experimental_context

Inject request-scoped context (user identity, database handles, session) into ToolLoopAgent tools via experimental_context, so the model never supplies sensitive identity in tool inputs.

aiagents+7
View pattern →

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 pattern →
Generate Text preview

Generate Text

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

aiprompt+3
View pattern →
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 pattern →
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 pattern →
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 pattern →
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 pattern →

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 →

tool( )

AI SDK tool API examples and patterns

12 patternsView →

You’ve reached the end of Agent( ).