AI SDK

The AI SDK is a TypeScript toolkit designed to help you build AI-powered applications using popular frameworks like Next.js, React, Svelte, Vue 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 18+ and pnpm installed on your local development machine.

1npm install ai

Usage

AI SDK Core

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

You will then install the model provider of your choice.

1npm install @ai-sdk/openai

@/index.ts (Node.js Runtime)

1import { generateText } from 'ai';
2import { openai } from '@ai-sdk/openai'; // Ensure OPENAI_API_KEY environment variable is set
3
4const { text } = await generateText({
5  model: openai('gpt-4o'),
6  system: 'You are a friendly assistant!',
7  prompt: 'Why is the sky blue?',
8});
9
10console.log(text);

AI SDK UI

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:

1npm install @ai-sdk/react

@/app/page.tsx (Next.js App Router)

1'use client';
2
3import { useChat } from '@ai-sdk/react';
4
5export default function Page() {
6  const { messages, input, handleSubmit, handleInputChange, status } =
7    useChat();
8
9  return (
10    <div>
11      {messages.map(message => (
12        <div key={message.id}>
13          <strong>{`${message.role}: `}</strong>
14          {message.parts.map((part, index) => {
15            switch (part.type) {
16              case 'text':
17                return <span key={index}>{part.text}</span>;
18
19              // other cases can handle images, tool calls, etc
20            }
21          })}
22        </div>
23      ))}
24
25      <form onSubmit={handleSubmit}>
26        <input
27          value={input}
28          placeholder="Send a message..."
29          onChange={handleInputChange}
30          disabled={status !== 'ready'}
31        />
32      </form>
33    </div>
34  );
35}

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

1import { streamText } from 'ai';
2import { openai } from '@ai-sdk/openai';
3
4export async function POST(req: Request) {
5  const { messages } = await req.json();
6
7  const result = streamText({
8    model: openai('gpt-4o'),
9    system: 'You are a helpful assistant.',
10    messages,
11  });
12
13  return result.toUIMessageStreamResponse();
14}

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 GitHub Discussions 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.