📄 ai-sdk/docs/reference/ai-sdk-rsc/create-streamable-ui

File: create-streamable-ui.md | Updated: 11/15/2025

Source: https://ai-sdk.dev/docs/reference/ai-sdk-rsc/create-streamable-ui

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

streamUI

createAI

createStreamableUI

createStreamableValue

readStreamableValue

getAIState

getMutableAIState

useAIState

useActions

useUIState

useStreamableValue

render (Removed)

Stream Helpers

AI SDK Errors

Migration Guides

Troubleshooting

Copy markdown

createStreamableUI

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

AI SDK RSC is currently experimental. We recommend using AI SDK UI for production. For guidance on migrating from RSC to UI, see our migration guide .

Create a stream that sends UI from the server to the client. On the client side, it can be rendered as a normal React node.

Import


import { createStreamableUI } from "@ai-sdk/rsc"

API Signature


Parameters

initialValue?:

ReactNode

The initial value of the streamable UI.

Returns

value:

ReactNode

The value of the streamable UI. This can be returned from a Server Action and received by the client.

Methods

update:

(ReactNode) => void

Updates the current UI node. It takes a new UI node and replaces the old one.

append:

(ReactNode) => void

Appends a new UI node to the end of the old one. Once appended a new UI node, the previous UI node cannot be updated anymore.

done:

(ReactNode | null) => void

Marks the UI node as finalized and closes the stream. Once called, the UI node cannot be updated or appended anymore. This method is always required to be called, otherwise the response will be stuck in a loading state.

error:

(Error) => void

Signals that there is an error in the UI stream. It will be thrown on the client side and caught by the nearest error boundary component.

Examples


Render a React component during a tool call

On this page

createStreamableUI

Import

API Signature

Parameters

Returns

Methods

Examples

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