Hono
You can use the AI SDK in a Hono server to generate and stream text and objects to the client.
Examples
The examples start a simple HTTP server that listens on port 8080. You can e.g. test it using curl
:
curl -X POST http://localhost:8080
The examples use the OpenAI gpt-4o
model. Ensure that the OpenAI API key is
set in the OPENAI_API_KEY
environment variable.
Full example: github.com/vercel/ai/examples/hono
UI Message Stream
You can use the toUIMessageStreamResponse
method to create a properly formatted streaming response.
import { openai } from '@ai-sdk/openai';import { serve } from '@hono/node-server';import { streamText } from 'ai';import { Hono } from 'hono';
const app = new Hono();
app.post('/', async c => { const result = streamText({ model: openai('gpt-4o'), prompt: 'Invent a new holiday and describe its traditions.', }); return result.toUIMessageStreamResponse();});
serve({ fetch: app.fetch, port: 8080 });
Text Stream
You can use the toTextStreamResponse
method to return a text stream response.
import { openai } from '@ai-sdk/openai';import { serve } from '@hono/node-server';import { streamText } from 'ai';import { Hono } from 'hono';
const app = new Hono();
app.post('/text', async c => { const result = streamText({ model: openai('gpt-4o'), prompt: 'Write a short poem about coding.', }); return result.toTextStreamResponse();});
serve({ fetch: app.fetch, port: 8080 });
Sending Custom Data
You can use createUIMessageStream
and createUIMessageStreamResponse
to send custom data to the client.
import { openai } from '@ai-sdk/openai';import { serve } from '@hono/node-server';import { createUIMessageStream, createUIMessageStreamResponse, streamText,} from 'ai';import { Hono } from 'hono';
const app = new Hono();
app.post('/stream-data', async c => { // immediately start streaming the response const stream = createUIMessageStream({ execute: ({ writer }) => { writer.write({ type: 'start' });
writer.write({ type: 'data-custom', data: { custom: 'Hello, world!', }, });
const result = streamText({ model: openai('gpt-4o'), prompt: 'Invent a new holiday and describe its traditions.', });
writer.merge( result.toUIMessageStream({ 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); }, }), ); }, }); return createUIMessageStreamResponse({ stream });});
serve({ fetch: app.fetch, port: 8080 });
Troubleshooting
- Streaming not working when proxied