createUIMessageStreamResponse
API Reference for createUIMessageStreamResponse.
The createUIMessageStreamResponse function creates a Response object that streams UI messages to the client.
Import
import { createUIMessageStreamResponse } from "ai"
Example
API Signature
Parameters
stream:
ReadableStream<UIMessageChunk>
The UI message stream to send to the client.
status?:
number
The status code for the response. Defaults to 200.
statusText?:
string
The status text for the response.
headers?:
Headers | Record<string, string>
Additional headers for the response.
keepAliveMs?:
number
Interval in milliseconds for sending SSE keep-alive comments. When set, an opening comment is sent immediately and additional comments are sent after the stream has been idle for the configured interval.
consumeSseStream?:
(options: { stream: ReadableStream<string> }) => PromiseLike<void> | void
Optional callback to consume the Server-Sent Events stream.
Returns
Response
A Response object that streams UI message chunks with the specified status, headers, and content.