Loading pattern preview
BlocksArtifacts
Agent Text Artifact
Agent Text Artifact
Template-style text artifact with data-textDelta streaming via @aisdkagents/react DataStreamController + ArtifactSession, ProseMirror Markdown editor, in-memory versions, and quick prompts — no database persistence.
Use this when an agent should stream Markdown text into a document the user can edit in a rich editor next to the chat, with versions kept in memory.
Loading pattern preview
Problems solved
Technical challenges this implementation handles out of the box.
- Stream Markdown document updates with data-textDelta UI parts
- Edit artifact text in a ProseMirror Markdown editor
- Keep document versions in memory without database persistence
- Update the document from agent tools and quick prompts
Use cases
Products and workflows this pattern is designed to support.
- Long-form writing copilots
- Chat-linked document editors
- Markdown artifact prototypes
- Vercel-style text artifact templates
Compare with
Similar patterns, and when each one is the better fit.
Agent Code ArtifactUse this when users and agent tools both edit a runnable Python file beside the chat and you only need in-memory version history.
Agent Slides ArtifactUse this when you are prototyping an agent that builds slide decks as a sortable, editable artifact streamed through data-slidesDelta parts.
Agent Sheet ArtifactUse this when a chat agent should stream CSV table updates into a side artifact panel the user can edit as a grid, with versions kept in memory.
Agent PDF ArtifactUse this when your agent writes a report or brief and users need to watch a live PDF preview fill in, then download it as a .pdf file.
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
Download → Next.js app
Use Download → Next.js app in the preview toolbar. You get a zip scaffold (Pro downloads rewrite preview `/view/.../api/*` paths to `/api/*` automatically).
- 2
Extract the zip and install dependencies
Unzip the archive, then run `pnpm install` (or npm / yarn) in the project folder.
- 3
Fill .env.local
The download includes .env.local placeholders when needed. Add real values for: AI_GATEWAY_API_KEY.
- 4
Customize the agent and tool files
Adapt prompts, tools, and stop conditions in the generated project for your product.
- 5
Run the app and open the pattern route
Run `pnpm dev`, open the setup/checklist page if present, then navigate to the generated pattern route and verify responses.
Environment variables
AI_GATEWAY_API_KEYGet key
Capabilities
AI SDK APIs
streamTextcreateUIMessageStreamgatewaytoolProviders
OpenAI
External services
Upstash
Files added
23 files
app/page.tsxapp/layout.tsxapp/api/agent-text-artifact/route.tscomponents/agent-text-demo.tsxcomponents/text-artifact-tool.tsxcomponents/text-artifact-panel.tsxcomponents/empty-state.tsxcomponents/diff-view.tsxhooks/use-text-panel.tsxlib/types.tslib/schema.tslib/create-artifact.tslib/text-artifact.tsxlib/text-artifact-session.tslib/artifacts.tslib/rate-limit.tslib/request-utils.tslib/chat-editor/config.tslib/chat-editor/functions.tsxlib/chat-editor/pm-schema.tslib/chat-editor/suggestions.tslib/chat-editor/diff.tsREADME.md
Dependencies
24 total
npm packages
20AISDK@aisdkagents/reactUpstashdate-fnsdiff-match-patchlucide-reactNext.jsorderedmapprosemirror-example-setupprosemirror-inputrulesprosemirror-markdownprosemirror-modelprosemirror-schema-basicprosemirror-schema-listprosemirror-stateprosemirror-viewReactsonnerusehooks-tsZod
Registry components
buttondraweremptytooltip
Critical files
2 files
lib/text-artifact.tsxDefines textArtifact with onStreamPart for data-textDelta, ProseMirror Editor content, and actions.
agent-text-artifact/route.tscreateUIMessageStream merges streamText with updateTextDocument tool; emits data-id, data-title, data-kind, data-textDelta, data-finish.
Requirements
- Complexity
- Intermediate
- Setup time
- ~8 minutes
- Node
- 24+
- Memory
- 256MB
Upstash Redis
