Loading pattern preview
BlocksArtifacts
Agent Sheet Artifact
Agent Sheet Artifact
Template-style sheet artifact with data-sheetDelta streaming, CSV grid editor, in-memory versions, and quick prompts — no database persistence.
Use 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.
Loading pattern preview
Problems solved
Technical challenges this implementation handles out of the box.
- Stream tabular CSV updates with data-sheetDelta UI parts
- Edit sheet content in a CSV grid artifact panel
- Keep version history in memory without database persistence
- Drive sheet updates from agent tool calls and quick prompts
Use cases
Products and workflows this pattern is designed to support.
- Chat spreadsheet prototypes
- Budget and forecast sheet copilots
- In-browser CSV artifact demos
- Vercel-style sheet artifact templates
Compare with
Similar patterns, and when each one is the better fit.
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 Text ArtifactUse 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.
Spreadsheet AgentUse this when users need a multi-sheet .xlsx with cleaned data, a chart, a summary, and a log of every transform the agent applied.
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.
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
18 files
app/page.tsxapp/layout.tsxapp/api/agent-sheet-artifact/route.tscomponents/agent-sheet-demo.tsxcomponents/sheet-csv-tool.tsxcomponents/sheet-artifact-panel.tsxcomponents/spreadsheet-editor.tsxcomponents/data-stream-provider.tsxcomponents/data-stream-handler.tsxcomponents/empty-state.tsxhooks/use-artifact.tsxlib/types.tslib/create-artifact.tslib/sheet-artifact.tsxlib/artifacts.tslib/rate-limit.tslib/request-utils.tsREADME.md
Dependencies
20 total
npm packages
11AISDKUpstashdate-fnslucide-reactNext.jspapaparseReactreact-data-gridsonnerusehooks-tsZod
Registry components
badgebuttoncollapsibledraweremptyinput-groupscroll-areatextareatooltip
Critical files
2 files
lib/sheet-artifact.tsxDefines sheetArtifact with onStreamPart for data-sheetDelta, SpreadsheetEditor content, actions, and toolbar.
agent-sheet-artifact/route.tscreateUIMessageStream merges streamText with updateSheetCsv tool; emits data-id, data-title, data-kind, data-sheetDelta, data-finish.
Requirements
- Complexity
- Intermediate
- Setup time
- ~8 minutes
- Node
- 24+
- Memory
- 256MB
Upstash Redis
