PatternsSDK API

Stream Text

Loading pattern preview

Problems solved

Technical challenges this implementation handles out of the box.
  • Stream text tokens to the client in real time
  • Render live completions with useCompletion
  • Demonstrate AI SDK streaming text over an API route

Use cases

Products and workflows this pattern is designed to support.
  • Streaming chat input demos
  • Live writing assistants
  • AI SDK streamText onboarding samples
  • Character-counted prompt UIs

Setup

Requirements, wiring steps, and what this pattern adds to your project.

Getting started

Pick how you want to pull this pattern in. Then wire env vars and routes the same way.

  1. 1

    Install from the preview toolbar

    Shadcn Icon

    Copy the install command above and run it in your project — Pro patterns include a short-lived token.

  2. 2

    Add environment variables to .env.local

    OPENAI_API_KEY

  3. 3

    Point client fetches at your API routes

    Replace preview `/view/.../api/...` paths with `/api/...` in the installed files.

  4. 4

    Customize the agent and tool files

    Adapt prompts, tools, and stop conditions for your product — Copy for AI in the toolbar helps seed that work.

  5. 5

    Run your dev server and open the pattern route

    Install dependencies if needed, then start the app and verify responses.

Environment variables

Capabilities

AI SDK APIs

streamTextuseCompletion

Providers

OpenAI

Files added

4 files
  • app/page.tsx
  • app/layout.tsx
  • components/basic-stream-text-form.tsx
  • app/api/stream-text/route.ts

Dependencies

8 total

npm packages

4
AISDKlucide-reactNext.jsReact

Shadcn IconRegistry components

4
input-groupseparatoremptyalert

Critical files

  • stream-text/route.ts

    API route demonstrating the AI SDK streamText function with gateway pattern. Shows the streaming text pattern using toUIMessageStreamResponse() for real-time token delivery.

Requirements

Complexity
Beginner