Loading pattern preview
BlocksArtifacts
Agent DOCX Artifact
Agent DOCX Artifact
Download-first Word artifact pattern. The agent streams Markdown through a tool call, renders a document preview, and exports a real .docx file.
Use this when your agent drafts documents that users must download as editable Word files, built client-side from Markdown streamed via a tool call.
Loading pattern preview
Problems solved
Technical challenges this implementation handles out of the box.
- Stream Markdown as the source for a Word artifact
- Preview document content before download
- Export a real .docx file client-side from streamed Markdown
Use cases
Products and workflows this pattern is designed to support.
- Proposal and report generation
- Client-ready Word drafts
- Memos, briefs, and lightweight contracts
- Download-first document agents
Compare with
Similar patterns, and when each one is the better fit.
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 XLSX ArtifactUse this when your chat agent needs to hand users a downloadable .xlsx file, previewing the tabular data it streams as CSV before export.
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.
Agent Slides ArtifactUse this when you are prototyping an agent that builds slide decks as a sortable, editable artifact streamed through data-slidesDelta parts.
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
12 files
app/page.tsxapp/layout.tsxapp/api/agent-docx-artifact/route.tscomponents/agent-docx-demo.tsxcomponents/microsoft-word.tsxcomponents/docx-tool.tsxcomponents/docx-artifact-panel.tsxlib/types.tslib/docx-export.tslib/rate-limit.tslib/request-utils.tsREADME.md
Dependencies
13 total
npm packages
8AISDKUpstashdocxlucide-reactNext.jsReactsonnerZod
Registry components
buttondraweremptyscroll-areatooltip
Critical files
2 files
agent-docx-artifact/route.tsAI SDK route that streams data-docxMarkdown from updateDocxMarkdown tool. Markdown is the editable/source representation for the .docx export.
components/docx-artifact-panel.tsxRight-side Drawer artifact panel that renders the streamed Markdown as a formatted document and exposes copy/download actions. Converts Markdown to a docx Document and downloads it with Packer.toBlob() via lib/docx-export.ts.
Requirements
- Complexity
- Intermediate
- Setup time
- ~8 minutes
- Node
- 24+
- Memory
- 256MB
Upstash Redis
