Loading pattern preview
PatternsArtifacts
Agent Text Artifact
Agent Text Artifact
Template-style text artifact with data-textDelta streaming, ProseMirror Markdown editor, in-memory versions, and quick prompts — no database persistence.
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
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
Install from the preview toolbar
Copy the install command above and run it in your project — Pro patterns include a short-lived token.
- 2
Add environment variables to .env.local
AI_GATEWAY_API_KEY
- 3
Point client fetches at your API routes
Replace preview `/view/.../api/...` paths with `/api/...` in the installed files.
- 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
Run your dev server and open the pattern route
Install dependencies if needed, then start the app and verify responses.
Environment variables
AI_GATEWAY_API_KEYGet key
Capabilities
AI SDK APIs
streamTextcreateUIMessageStreamgatewaytoolProviders
OpenAI
External services
Upstash
Files added
24 filesapp/page.tsxapp/layout.tsxapp/api/agent-text-artifact/route.tscomponents/agent-text-demo.tsxcomponents/text-artifact-tool.tsxcomponents/text-artifact-panel.tsxcomponents/data-stream-provider.tsxcomponents/data-stream-handler.tsxcomponents/empty-state.tsxcomponents/diff-view.tsxhooks/use-artifact.tsxlib/types.tslib/schema.tslib/create-artifact.tslib/text-artifact.tsxlib/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
23 totalnpm packages
19AISDKUpstashdate-fnsdiff-match-patchlucide-reactNext.jsorderedmapprosemirror-example-setupprosemirror-inputrulesprosemirror-markdownprosemirror-modelprosemirror-schema-basicprosemirror-schema-listprosemirror-stateprosemirror-viewReactsonnerusehooks-tsZod
Registry components
buttondraweremptytooltip
Critical 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
