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.

Loading 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

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, UPSTASH_REDIS_REST_URL, UPSTASH_REDIS_REST_TOKEN
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
UPSTASH_REDIS_REST_URLGet key
UPSTASH_REDIS_REST_TOKENGet key

Capabilities

AI SDK APIs

streamTextcreateUIMessageStreamgatewaytooluseChat

Providers

OpenAI

External services

Upstash

Files added

13 files

app/page.tsx
app/layout.tsx
app/api/agent-xlsx-artifact/route.ts
components/agent-xlsx-demo.tsx
components/microsoft-excel.tsx
components/xlsx-tool.tsx
components/xlsx-artifact-panel.tsx
components/spreadsheet-editor.tsx
lib/types.ts
lib/xlsx-export.ts
lib/rate-limit.ts
lib/request-utils.ts
README.md

Dependencies

15 total

npm packages

AISDKUpstashlucide-reactNext.jspapaparseReactreact-data-gridsonnerxlsxZod

Registry components

buttondraweremptyscroll-areatooltip

Critical files

agent-xlsx-artifact/route.ts
AI 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.tsx
Right-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.