`streamToResponse`

streamToResponse has been removed in AI SDK 4.0. Use pipeDataStreamToResponse from streamText instead.

streamToResponse pipes a data stream to a Node.js ServerResponse object and sets the status code and headers.

This is useful to create data stream responses in environments that use ServerResponse objects, such as Node.js HTTP servers.

The status code and headers can be configured using the options parameter. By default, the status code is set to 200 and the Content-Type header is set to text/plain; charset=utf-8.

Import

import { streamToResponse } from "ai"

Example

You can e.g. use streamToResponse to pipe a data stream to a Node.js HTTP server response:

import { openai } from '@ai-sdk/openai';
import { StreamData, streamText, streamToResponse } from 'ai';
import { createServer } from 'http';

createServer(async (req, res) => {
  const result = streamText({
    model: openai('gpt-4-turbo'),
    prompt: 'What is the weather in San Francisco?',
  });

  // use stream data
  const data = new StreamData();

  data.append('initialized call');

  streamToResponse(
    result.toAIStream({
      onFinal() {
        data.append('call completed');
        data.close();
      },
    }),
    res,
    {},
    data,
  );
}).listen(8080);

API Signature

Parameters

stream:

ReadableStream

The Web Stream to pipe to the response. It can be the return value of OpenAIStream, HuggingFaceStream, AnthropicStream, or an AIStream instance.

response:

ServerResponse

The Node.js ServerResponse object to pipe the stream to. This is usually the second argument of a Node.js HTTP request handler.

options:

Options

Configure the response

Options

status:

number

The status code to set on the response. Defaults to `200`.

headers:

Record<string, string>

Additional headers to set on the response. Defaults to `{ 'Content-Type': 'text/plain; charset=utf-8' }`.

data:

StreamData

StreamData object for forwarding additional data to the client.