Documentation
Everything in the studio, written down.
Start with a dataset and a story in ten minutes, then go deeper: beats, live bindings, the actions graph, embeds, the REST API and the MCP server your agents will use.
Claude Desktop · Cursor · Claude Code
{ "mcpServers": { "spatly": { "command": "npx", "args": ["-y", "@spatly/mcp"], "env": { "SPATLY_TOKEN": "spk_…" } } } }
Embed an Insight Container
<script src="https://spatly.io/embed.js" data-spatly="<publicId>" data-height="560"></script>
Start
Surfaces
- StoriesScroll-driven map narrative: chapters bind narrative blocks to beats, scroll progress drives the camera, and the editor is the viewer.11 sections · 3 annotated figures
- SlidesSpatial slide decks: full-viewport slides bound to beats, a frame canvas with presets, presenter mode and conversion from a story.6 sections · 2 annotated figures
- DashboardsLive operational dashboards: the grid, every widget, data binding, metrics, the actions graph, spatial and attribute filters, breakpoints, refresh and the ops theme.13 sections · 5 annotated figures
- Insight ContainersA portable, embeddable spatial insight object: a designed collapsed card that opens into the full workspace, on your site or in someone else's.8 sections · 3 annotated figures
Platform
- Data & live sourcesFormats and ingest, field inference, time fields, the live source catalog, URL/REST/webhook/MCP connections, refresh policies, query policy and limits.12 sections · 2 annotated figures
- Layers & stylingRender types, classification methods and ramps, labels and marks, 3D extrusion, remote raster and vector tiles, interactivity and legends.10 sections · 1 annotated figure
- Beats & cameraThe single spatial-state object every surface reuses: camera, per-beat layer states, highlights, annotations, basemap, terrain and time.12 sections · 1 annotated figure
- AnnotationsPins, callouts, lines, areas, arrows and numbered tours: drawing them, dragging them from the Library, editing them, and attaching them to beats.9 sections · 1 annotated figure
- Publishing & sharingVisibility states, short and pretty links, passwords, domain restriction, snapshots versus live layers, OG previews, deep links, the badge and viewer analytics.11 sections · 1 annotated figure
- ThemingThe four variants, design tokens, per-surface overrides, basemaps, the brand kit, and how what you design becomes what gets published.9 sections · 1 annotated figure
- Plans, limits & alertsWhat each plan includes, the limits the product enforces, the agent budget, alert rules on metrics, billing and refunds.6 sections · 3 annotated figures
Reference
- EmbeddingThe script loader and the plain iframe, every attribute, the postMessage contract in both directions, the window.Spatly helpers and domain restriction.11 sections · 1 annotated figure
- REST APIWorkspace tokens and scopes, every /api/v1 endpoint, the feature-query grammar, metrics, publishing, pagination, the agent budget and error codes.8 sections · 1 annotated figure
- MCP serverConnect Claude Desktop, Cursor, Claude Code or any MCP client to your workspace: transports, scopes, the twenty-one tools, resources and prompts, the agent budget, and worked sessions.8 sections · 1 annotated figure
- Spatly MarksThe first-party visual kit: UI icons, map markers, ornaments, chart marks and live affordances, and how to use it in Studio, on the map, and in your own apps via the export package.7 sections · 1 annotated figure
- Studio referenceEvery panel and inspector, the canvas tools, the keyboard map, the ⌘K command palette, the AI features, autosave and version history.9 sections · 3 annotated figures