📄 ai-sdk/docs/reference/stream-helpers/ai-stream

File: ai-stream.md | Updated: 11/15/2025

Source: https://ai-sdk.dev/docs/reference/stream-helpers/ai-stream

AI SDK

Menu

v5 (Latest)

AI SDK 5.x

AI SDK by Vercel

AI SDK 6 Beta

Foundations

Overview

Providers and Models

Prompts

Tools

Streaming

Getting Started

Navigating the Library

Next.js App Router

Next.js Pages Router

Svelte

Vue.js (Nuxt)

Node.js

Expo

Agents

Agents

Building Agents

Workflow Patterns

Loop Control

AI SDK Core

Overview

Generating Text

Generating Structured Data

Tool Calling

Model Context Protocol (MCP) Tools

Prompt Engineering

Settings

Embeddings

Image Generation

Transcription

Speech

Language Model Middleware

Provider & Model Management

Error Handling

Testing

Telemetry

AI SDK UI

Overview

Chatbot

Chatbot Message Persistence

Chatbot Resume Streams

Chatbot Tool Usage

Generative User Interfaces

Completion

Object Generation

Streaming Custom Data

Error Handling

Transport

Reading UIMessage Streams

Message Metadata

Stream Protocols

AI SDK RSC

Advanced

Reference

AI SDK Core

AI SDK UI

AI SDK RSC

Stream Helpers

AIStream

StreamingTextResponse

streamToResponse

OpenAIStream

AnthropicStream

AWSBedrockStream

AWSBedrockAnthropicStream

AWSBedrockAnthropicMessagesStream

AWSBedrockCohereStream

AWSBedrockLlama2Stream

CohereStream

GoogleGenerativeAIStream

HuggingFaceStream

@ai-sdk/langchain Adapter

@ai-sdk/llamaindex Adapter

MistralStream

ReplicateStream

InkeepStream

AI SDK Errors

Migration Guides

Troubleshooting

Copy markdown

AIStream

==================================================================================

AIStream has been removed in AI SDK 4.0. Use streamText.toDataStreamResponse() instead.

Creates a readable stream for AI responses. This is based on the responses returned by fetch and serves as the basis for the OpenAIStream and AnthropicStream. It allows you to handle AI response streams in a controlled and customized manner that will work with useChat and useCompletion.

AIStream will throw an error if response doesn't have a 2xx status code. This is to ensure that the stream is only created for successful responses.

Import


React

import { AIStream } from "ai"

API Signature


response:

Response

This is the response object returned by fetch. It's used as the source of the readable stream.

customParser:

(AIStreamParser) => void

This is a function that is used to parse the events in the stream. It should return a function that receives a stringified chunk from the LLM and extracts the message content. The function is expected to return nothing (void) or a string.

AIStreamParser

(data: string) => string | void

callbacks:

AIStreamCallbacksAndOptions

AIStreamCallbacksAndOptions

onStart:

() => Promise<void>

An optional function that is called at the start of the stream processing.

onCompletion:

(completion: string) => Promise<void>

An optional function that is called for every completion. It's passed the completion as a string.

onFinal:

(completion: string) => Promise<void>

An optional function that is called once when the stream is closed with the final completion message.

onToken:

(token: string) => Promise<void>

An optional function that is called for each token in the stream. It's passed the token as a string.

On this page

AIStream

Import

React

API Signature

Deploy and Scale AI Apps with Vercel.

Vercel delivers the infrastructure and developer experience you need to ship reliable AI-powered applications at scale.

Trusted by industry leaders:

  • OpenAI
  • Photoroom
  • leonardo-ai Logoleonardo-ai Logo
  • zapier Logozapier Logo

Talk to an expert