Loading pattern preview
BlocksArtifacts
Agent XLSX Artifact
Agent XLSX Artifact
Download-first Excel artifact pattern. The agent streams CSV through a tool call, renders a spreadsheet preview, and exports a real .xlsx file with SheetJS.
Use this when your chat agent needs to hand users a downloadable .xlsx file, previewing the tabular data it streams as CSV before export.
Loading pattern preview
Problems solved
Technical challenges this implementation handles out of the box.
- Stream workbook CSV from an agent tool call
- Preview tabular output before download
- Export a real .xlsx file client-side with SheetJS
Use cases
Products and workflows this pattern is designed to support.
- Excel report generation
- Budget and forecast spreadsheet exports
- Pipeline trackers and data exports
- Download-first spreadsheet agents
Compare with
Similar patterns, and when each one is the better fit.
Agent DOCX ArtifactUse this when your agent drafts documents that users must download as editable Word files, built client-side from Markdown streamed via a tool call.
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 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.
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.
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
streamTextcreateUIMessageStreamgatewaytooluseChatProviders
OpenAI
External services
Upstash
Files added
13 files
app/page.tsxapp/layout.tsxapp/api/agent-xlsx-artifact/route.tscomponents/agent-xlsx-demo.tsxcomponents/microsoft-excel.tsxcomponents/xlsx-tool.tsxcomponents/xlsx-artifact-panel.tsxcomponents/spreadsheet-editor.tsxlib/types.tslib/xlsx-export.tslib/rate-limit.tslib/request-utils.tsREADME.md
Dependencies
15 total
npm packages
10AISDKUpstashlucide-reactNext.jspapaparseReactreact-data-gridsonnerxlsxZod
Registry components
buttondraweremptyscroll-areatooltip
Critical files
2 files
agent-xlsx-artifact/route.tsAI SDK route that streams data-xlsxCsv from updateWorkbookCsv tool. The model produces CSV as a source representation for a downloadable .xlsx artifact.
components/xlsx-artifact-panel.tsxRight-side Drawer artifact panel that renders the streamed CSV in a spreadsheet grid and exposes copy/download actions. Converts CSV to a SheetJS workbook and downloads .xlsx via lib/xlsx-export.ts.
Requirements
- Complexity
- Intermediate
- Setup time
- ~8 minutes
- Node
- 24+
- Memory
- 256MB
Upstash Redis
