createUIMessageStream and pipeUIMessageStreamToResponse can be used to send custom data to the client.
This example handles the /stream-data path, so test it with curl -X POST http://localhost:8080/stream-data.
index.ts
import { createUIMessageStream, pipeUIMessageStreamToResponse, streamText, toUIMessageStream,} from 'ai';import { createServer } from 'http';createServer(async (req, res) => { switch (req.url) { case '/stream-data': { const stream = createUIMessageStream({ execute: ({ writer }) => { // write some custom data writer.write({ type: 'start' }); writer.write({ type: 'data-custom', data: { custom: 'Hello, world!', }, }); const result = streamText({ model: 'openai/gpt-6-astra', prompt: 'Invent a new holiday and describe its traditions.', }); writer.merge( toUIMessageStream({ stream: result.stream, sendStart: false, onError: error => { // Error messages are masked by default for security reasons. // If you want to expose the error message to the client, you can do so here: return error instanceof Error ? error.message : String(error); }, }), ); }, }); pipeUIMessageStreamToResponse({ stream, response: res }); break; } }}).listen(8080);