@ai-sdk/openai
v4.0.71
Published
Downloads
44,647,587
Keywords
Readme
AI SDK - OpenAI Provider
The OpenAI provider for the AI SDK contains language model support for the OpenAI chat and completion APIs and embedding model support for the OpenAI embeddings API.
Deploying to Vercel? With Vercel's AI Gateway you can access OpenAI (and hundreds of models from other providers) — no additional packages, API keys, or extra cost. Get started with AI Gateway.
Setup
The OpenAI provider is available in the @ai-sdk/openai module. You can install it with
npm i @ai-sdk/openaiSkill 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/aiProvider Instance
You can import the default provider instance openai from @ai-sdk/openai:
import { openai } from '@ai-sdk/openai';Example
import { openai } from '@ai-sdk/openai';
import { generateText } from 'ai';
const { text } = await generateText({
model: openai('gpt-5-mini'),
prompt: 'Write a vegetarian lasagna recipe for 4 people.',
});Documentation
Experimental realtime models
Use the same factory for OpenAI Realtime and Live models:
openai.experimental_realtime('gpt-realtime');
openai.experimental_realtime('gpt-live-1');
openai.experimental_realtime('not-yet-released', { api: 'live' });Live supports browser WSS sessions through an application-owned relay and
experimental_useRealtime, with client delegation: your application owns the
agent and tools. Optional browser-direct WebRTC is also available. Start with the
OpenAI provider documentation
for connection settings, startup options, and event mapping.
The experimental_useRealtime reference
covers the JSON/PCM16 relay runtime, capture/playback controls, and application-handled
client delegation, plus api.session WebRTC setup and server-owned data-channel
permissions. Microphone capture requires browser permission; the application handles
client delegation and submits context on either transport. The
Realtime guide covers legacy token-based,
turn-based sessions.
Runtime and provider authors can consult the repository's realtime integration notes.
