Loading pattern preview
BlocksArtifacts
Agent Map Artifact
Agent Map Artifact
Template-style GeoJSON map artifact with data-mapDelta streaming, MapLibre preview and JSON source editor, GeoJSON export, in-memory versions, and quick prompts — no database persistence.
Use this when you are prototyping a location-focused copilot that writes GeoJSON shown on a live map beside its JSON source.
Loading pattern preview
Problems solved
Technical challenges this implementation handles out of the box.
- Stream GeoJSON map data with data-mapDelta UI parts
- Preview maps with MapLibre while editing JSON source
- Export GeoJSON from the artifact toolbar
- Keep map versions in memory without database persistence
Use cases
Products and workflows this pattern is designed to support.
- Location-centric agent demos
- Route and territory visualizations
- Field-ops map copilots
- GeoJSON artifact prototypes
Compare with
Similar patterns, and when each one is the better fit.
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.
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 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.
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
streamTextcreateUIMessageStreamgatewaytoolProviders
OpenAI
External services
Upstash
Files added
21 files
app/page.tsxapp/layout.tsxapp/api/agent-map-artifact/route.tscomponents/agent-map-demo.tsxcomponents/map-artifact-tool.tsxcomponents/map-artifact-panel.tsxcomponents/map-artifact-preview.tsxcomponents/map.tsxcomponents/data-stream-provider.tsxcomponents/data-stream-handler.tsxcomponents/empty-state.tsxhooks/use-artifact.tsxlib/types.tslib/create-artifact.tslib/map-artifact.tsxlib/map-document.tslib/geo-summary.tslib/artifacts.tslib/rate-limit.tslib/request-utils.tsREADME.md
Dependencies
17 total
npm packages
10AISDKUpstashdate-fnslucide-reactmaplibre-glNext.jsReactsonnerusehooks-tsZod
Registry components
buttoncollapsibledraweremptytabstextareatooltip
Critical files
2 files
lib/map-artifact.tsxDefines mapArtifact with onStreamPart for data-mapDelta, Map preview and JSON source tabs, and GeoJSON actions.
agent-map-artifact/route.tscreateUIMessageStream merges streamText with updateMapArtifact tool; emits data-id, data-title, data-kind, data-mapDelta, data-finish.
Requirements
- Complexity
- Intermediate
- Setup time
- ~8 minutes
- Node
- 24+
- Memory
- 256MB
Upstash RedisMapLibre / shadcn map component
