Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

History

7,810 Commits

Repository files navigation

hero illustration

AI SDK

The AI SDK is a provider-agnostic TypeScript toolkit designed to help you build AI-powered applications and agents using popular UI frameworks like Next.js, React, Svelte, Vue, Angular, and runtimes like Node.js.

To learn more about how to use the AI SDK, check out our API Reference and Documentation.

Installation

You will need Node.js 22+ and npm (or another package manager) installed on your local development machine.

npm install ai

Skill for Coding Agents

If you use coding agents such as Claude Code or Cursor, we highly recommend adding the AI SDK skill to your repository:

npx skills add vercel/ai

Unified Provider Architecture

The AI SDK provides a unified API to interact with model providers like OpenAI, Anthropic, Google, and more.

By default, the AI SDK uses the Vercel AI Gateway to give you access to all major providers out of the box. Just pass a model string for any supported model:

constresult=awaitgenerateText({model: 'anthropic/claude-opus-4.6',// or 'openai/gpt-5.4', 'google/gemini-3-flash', etc.prompt: 'Hello!',});

You can also connect to providers directly using their SDK packages:

npm install @ai-sdk/openai @ai-sdk/anthropic @ai-sdk/google
import{anthropic}from'@ai-sdk/anthropic';constresult=awaitgenerateText({model: anthropic('claude-opus-4-6'),// or openai('gpt-5.4'), google('gemini-3-flash'), etc.prompt: 'Hello!',});

Usage

Generating Text

import{generateText}from'ai';const{ text }=awaitgenerateText({model: 'openai/gpt-5.4',// use Vercel AI Gatewayprompt: 'What is an agent?',});

Generating Structured Data

import{generateText,Output}from'ai';import{z}from'zod';const{ output }=awaitgenerateText({model: 'openai/gpt-5.4',output: Output.object({schema: z.object({recipe: z.object({name: z.string(),ingredients: z.array(z.object({name: z.string(),amount: z.string()}),),steps: z.array(z.string()),}),}),}),prompt: 'Generate a lasagna recipe.',});

Agents

import{ToolLoopAgent}from'ai';constsandboxAgent=newToolLoopAgent({model: 'openai/gpt-5.4',system: 'You are an agent with access to a shell environment.',tools: {shell: openai.tools.localShell({execute: async({ action })=>{const[cmd, ...args]=action.command;constsandbox=awaitgetSandbox();// Vercel Sandboxconstcommand=awaitsandbox.runCommand({ cmd, args });return{output: awaitcommand.stdout()};},}),},});

UI Integration

The AI SDK UI module provides a set of hooks that help you build chatbots and generative user interfaces. These hooks are framework agnostic, so they can be used in Next.js, React, Svelte, and Vue.

You need to install the package for your framework, e.g.:

npm install @ai-sdk/react

Agent @/agent/image-generation-agent.ts

import{openai}from'@ai-sdk/openai';import{ToolLoopAgent,InferAgentUIMessage}from'ai';exportconstimageGenerationAgent=newToolLoopAgent({model: 'openai/gpt-5.4',tools: {generateImage: openai.tools.imageGeneration({partialImages: 3,}),},});exporttypeImageGenerationAgentMessage=InferAgentUIMessage<typeofimageGenerationAgent>;

Route (Next.js App Router) @/app/api/chat/route.ts

import{imageGenerationAgent}from'@/agent/image-generation-agent';import{createAgentUIStreamResponse}from'ai';exportasyncfunctionPOST(req: Request){const{ messages }=awaitreq.json();returncreateAgentUIStreamResponse({agent: imageGenerationAgent,
messages,});}

UI Component for Tool @/component/image-generation-view.tsx

import{openai}from'@ai-sdk/openai';import{UIToolInvocation}from'ai';exportdefaultfunctionImageGenerationView({
invocation,}: {invocation: UIToolInvocation<ReturnType<typeofopenai.tools.imageGeneration>>;}){switch(invocation.state){case'input-available':
return<div>Generating image...</div>;case'output-available':
return<imgsrc={`data:image/png;base64,${invocation.output.result}`}/>;}}

Page @/app/page.tsx

'use client';import{ImageGenerationAgentMessage}from'@/agent/image-generation-agent';importImageGenerationViewfrom'@/component/image-generation-view';import{useChat}from'@ai-sdk/react';exportdefaultfunctionPage(){const{ messages, status, sendMessage }=useChat<ImageGenerationAgentMessage>();const[input,setInput]=useState('');consthandleSubmit=e=>{e.preventDefault();sendMessage({text: input});setInput('');};return(<div>{messages.map(message=>(<divkey={message.id}><strong>{`${message.role}: `}</strong>{message.parts.map((part,index)=>{switch(part.type){case'text':
return<divkey={index}>{part.text}</div>;case'tool-generateImage':
return<ImageGenerationViewkey={index}invocation={part}/>;}})}</div>))}<formonSubmit={handleSubmit}><inputvalue={input}onChange={e=>setInput(e.target.value)}disabled={status!=='ready'}/></form></div>);}

Templates

We've built templates that include AI SDK integrations for different use cases, providers, and frameworks. You can use these templates to get started with your AI-powered application.

Community

The AI SDK community can be found on the Vercel Community where you can ask questions, voice ideas, and share your projects with other people.

Contributing

Contributions to the AI SDK are welcome and highly appreciated. However, before you jump right into it, we would like you to review our Contribution Guidelines to make sure you have smooth experience contributing to AI SDK.

Authors

This library is created by Vercel and Next.js team members, with contributions from the Open Source Community.

About

The AI Toolkit for TypeScript. From the creators of Next.js, the AI SDK is a free open-source library for building AI-powered applications and agents

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

26.0k stars

Watchers

144 watching

Forks

Releases

Used by

Contributors

Languages