# MapX ## Documentation ### Get Started - [MapX: AI-Powered Spatial Data Exploration](https://docs.mapxagent.com/en/introduction.md): MapX is a browser-based, AI-driven spatial data exploration platform. Bring in data, ask questions in plain language, and get interactive maps, charts, and professional reports in seconds — no GIS software required. - [Quickstart: Upload Data and Build Your First MapX Map](https://docs.mapxagent.com/en/quickstart.md): Learn how to upload a dataset, run your first spatial analysis, and polish or share the result in under a minute using MapX's AI chat interface. - [Uploading and Preparing Your Location Data in MapX](https://docs.mapxagent.com/en/uploading-data.md): Learn how to upload CSV, GeoJSON, and Excel files to MapX. Covers automatic location column detection, column naming tips, and fixing common import errors. ### Core Concepts - [Using the MapX AI Chat Interface for Spatial Analysis](https://docs.mapxagent.com/en/concepts/ai-chat.md): MapX's AI chat lets you run buffer zones, spatial joins, heatmaps, and site scoring in plain English. Learn how to write effective spatial prompts. - [Plan mode](https://docs.mapxagent.com/en/concepts/plan-mode.md): Plan mode makes MapX research first and act only after you approve: clarifying questions, a read-only study, a plan document you review, and a decision card that starts execution. - [Spatial analysis in MapX](https://docs.mapxagent.com/en/concepts/analysis.md): MapX analysis runs deterministic spatial tools — distance, overlay, network, terrain, raster and statistics — against your project data. Start them from the chat or from the Analysis catalog. - [Built-in datasets](https://docs.mapxagent.com/en/concepts/builtin-datasets.md): MapX ships a curated catalog of global datasets — terrain, water, climate, hazards, population, facilities and boundaries — that you can add to any project without uploading anything. - [Workflows and plans](https://docs.mapxagent.com/en/concepts/workflows.md): MapX turns a multi-step analysis into a plan you approve, a graph you can watch, and a reusable workflow you can run on new data. - [Working with Layers in MapX](https://docs.mapxagent.com/en/concepts/layers.md): Manage, style, and edit every layer in a MapX project — toggle visibility, filter and search, reorder, batch-manage, restyle, and edit attributes or geometry directly. - [Viewing your map in 3D](https://docs.mapxagent.com/en/concepts/3d-view.md): Tilt the map into a 3D perspective, render layers as columns, paths, arcs, or extruded areas, and control each layer's 3D style. - [Choosing and Customizing the Basemap](https://docs.mapxagent.com/en/concepts/basemap.md): Choose between light and dark basemap styles, switch between labeled and unlabeled variants, and customize category colors and visibility per project. - [Files in a MapX Project](https://docs.mapxagent.com/en/concepts/files.md): How MapX stores uploaded datasets, documents, and AI-generated data — and how to preview, reference, search, and manage files in the Data panel. - [Generating and Delivering Professional Reports](https://docs.mapxagent.com/en/concepts/reports.md): Turn any MapX analysis into an HTML, Word, or PPT report with maps, charts, tables, and AI-written insights — preview it, iterate with the AI, export a PDF, and share. - [Charts](https://docs.mapxagent.com/en/concepts/charts.md): Create charts from your layers and files with AI chat, style and pin them to the map, export them, and include them in reports. - [MCP connections](https://docs.mapxagent.com/en/concepts/mcp.md): How to connect your own external tools to MapX through the Model Context Protocol (MCP). - [Skills](https://docs.mapxagent.com/en/concepts/skills.md): Skills are instruction packs you upload so the MapX AI follows your team's specialized workflows. - [Knowledge bases](https://docs.mapxagent.com/en/concepts/knowledge-bases.md): Give the MapX AI retrievable documents — upload files or ingest URLs, then ask questions and get answers grounded in your content. - [Database connections](https://docs.mapxagent.com/en/concepts/database-connections.md): Connect MapX to an external PostgreSQL or MySQL database to query data in chat, import results as layers, or turn PostGIS spatial tables into live map layers. ### Scenarios - [Scenarios](https://docs.mapxagent.com/en/concepts/scenarios.md): A MapX scenario is a ready-made starting point: a study area, its prepared datasets, a method, and questions you can ask straight away. #### Built-in scenarios - [Development Suitability Baseline · Nairobi](https://docs.mapxagent.com/en/concepts/scenarios/development-suitability-baseline.md): Screen ecological, terrain and flood constraints in Nairobi, grade the remaining land, estimate carrying capacity and propose a development boundary with tiered controls. - [Carrying Capacity Assessment · Jakarta](https://docs.mapxagent.com/en/concepts/scenarios/carrying-capacity-assessment.md): Assess how terrain, wetness, flood depth and rainfall constrain Jakarta's growth, grade carrying capacity, and flag the districts where pressure is highest. - [15-minute Neighbourhood Coverage · Jakarta](https://docs.mapxagent.com/en/concepts/scenarios/15min-life-circle-coverage.md): Audit who can reach a school, a clinic and a park within an 800 m walk in central Jakarta, rank the neighbourhoods with the biggest shortfall, and score accessibility. - [Public Facility Siting · Dar es Salaam](https://docs.mapxagent.com/en/concepts/scenarios/public-facility-siting.md): Diagnose school and clinic coverage in Dar es Salaam, measure the unserved demand, then compare candidate sites and recommend where to build with a maximum-coverage model. - [Urban Growth Monitor · Hanoi](https://docs.mapxagent.com/en/concepts/scenarios/urban-growth-monitor.md): Reconstruct Hanoi's built-up expansion phase by phase, measure how much is infill versus outward growth, and connect growth to population and night lights. - [Land-use Conflict Screening · Kigali](https://docs.mapxagent.com/en/concepts/scenarios/landuse-conflict-screening.md): Find where Kigali's development presses on ecological space, steep slopes and riverbanks, grade the conflicts, and turn them into remediation priorities. ### Sharing & Export - [Sharing maps, reports, and projects](https://docs.mapxagent.com/en/sharing/sharing-maps.md): Share MapX work as an embeddable map, a live view, a high-resolution image, an HTML report link, or project access for a teammate. - [Exporting maps, data, charts, and reports](https://docs.mapxagent.com/en/sharing/exporting.md): Take work out of MapX: map images, layer data as GeoJSON or Shapefile, chart PNG and CSV, HTML / Word / PowerPoint reports, and project manifests. ### Integration - [Agent tools](https://docs.mapxagent.com/en/integration/agent-tools.md): Give any LLM agent one link: it downloads the mapx skill, installs the CLI, and can drive MapX projects. ### Plans & Account - [MapX Plans and Pricing: Free, Basic, Pro, and Business](https://docs.mapxagent.com/en/account/plans.md): Compare MapX plans — Free, Basic ($29/mo), Pro ($99/mo), and Business ($999/mo) — and understand how credit billing works. - [MapX credits: how AI usage is billed](https://docs.mapxagent.com/en/account/credits.md): MapX bills AI usage in credits based on actual token consumption. Learn how credits are calculated, what each plan includes, and how to top up. - [MapX Data Security: Storage, Privacy, and Access Control](https://docs.mapxagent.com/en/account/data-security.md): Learn how MapX stores and protects your location data. Projects are private by default, and access is only granted when you explicitly share. ### Help - [MapX Frequently Asked Questions: Plans, Data, and Features](https://docs.mapxagent.com/en/help/faq.md): Answers to the most common questions about MapX — data safety, GIS capabilities, plans, cancellation, and getting professional results. - [Troubleshooting MapX: Uploads, AI Chat, and Export Issues](https://docs.mapxagent.com/en/help/troubleshooting.md): Fix common MapX issues including data upload errors, AI chat problems, rendering slowdowns, location detection failures, and export errors. ## Developers ### Get Started - [Developer overview](https://docs.mapxagent.com/en/developers/overview.md): Integrate MapX with your own applications through the API, CLI, and skill system. - [Authentication](https://docs.mapxagent.com/en/developers/authentication.md): Authenticate API requests with a personal API key. ### API Reference #### Projects - [List projects](https://docs.mapxagent.com/api-reference/projects/list-projects.md): Requires scope: session. - [Create a project](https://docs.mapxagent.com/api-reference/projects/create-a-project.md): Requires scope: session. - [Get a project](https://docs.mapxagent.com/api-reference/projects/get-a-project.md): Requires scope: session. - [Delete a project](https://docs.mapxagent.com/api-reference/projects/delete-a-project.md): Requires scope: session. - [Partially update a project](https://docs.mapxagent.com/api-reference/projects/partially-update-a-project.md): Partial update with merge semantics (PATCH): only fields present in the request body are applied; omitted fields retain their current values. mapState is merged into the existing map state (shallow merge), so a partial mapState (e.g. only basemap) preserves the other viewport fields; nested objects… - [Get the live view URL for a project](https://docs.mapxagent.com/api-reference/projects/get-the-live-view-url-for-a-project.md): Requires scope: remote. Returns a URL to a real-time map page that stays in sync with the project via SSE; suitable for embedding in third-party tools. - [Get the static embed URL for a project](https://docs.mapxagent.com/api-reference/projects/get-the-static-embed-url-for-a-project.md): Requires scope: remote. Returns a URL to a read-only static snapshot of the project, suitable for embedding as an iframe in reports. #### Map - [Get the project map state](https://docs.mapxagent.com/api-reference/map/get-the-project-map-state.md): Requires scope: session. - [Dispatch map actions](https://docs.mapxagent.com/api-reference/map/dispatch-map-actions.md): Requires scope: map. Applies a list of map actions to the live project, in order. Supported action types: fly_to, jump_to, fit_bounds, go_home, zoom_in, zoom_out, pan, zoom_to_layer, add_geojson_layer, add_tile_layer, add_cog_layer, remove_layer, rename_layer, set_layer_visibility, move_layer_up, mo… #### Chat - [Start an AI chat turn](https://docs.mapxagent.com/api-reference/chat/start-an-ai-chat-turn.md): Requires scope: chat. Streams turn events as SSE (text/event-stream). Returns 409 if a turn is already in progress. - [Answer a pending AI question](https://docs.mapxagent.com/api-reference/chat/answer-a-pending-ai-question.md): Requires scope: chat. #### Files - [List project files](https://docs.mapxagent.com/api-reference/files/list-project-files.md): Requires scope: files. - [Upload a file](https://docs.mapxagent.com/api-reference/files/upload-a-file.md): Requires scope: files. Multipart upload. Supported extensions: .csv, .geojson, .json, .xlsx, .xls, .txt, .md, .docx, .doc, .pdf, .tif, .tiff. GeoJSON/JSON are added as layers directly; CSV/Excel are converted to GeoJSON layers; TIFF is converted to a COG image layer; text/document files are stored a… - [Get file content](https://docs.mapxagent.com/api-reference/files/get-file-content.md): Requires scope: files. Returns the raw file bytes. - [Delete a file](https://docs.mapxagent.com/api-reference/files/delete-a-file.md): Requires scope: files. Deletes the file and any layers that reference it. Idempotent: deleting an unknown file id still returns 200. - [List all data assets](https://docs.mapxagent.com/api-reference/files/list-all-data-assets.md): Requires scope: files or layers. Returns the project's map layers and files (files that back a layer are shown only as part of that layer). #### Layers - [List project layers](https://docs.mapxagent.com/api-reference/layers/list-project-layers.md): Requires scope: layers. - [Get layer details](https://docs.mapxagent.com/api-reference/layers/get-layer-details.md): Requires scope: layers. Returns geometry type, fields, current renderer, label, and feature count. - [Delete a layer](https://docs.mapxagent.com/api-reference/layers/delete-a-layer.md): Requires scope: layers. - [Rename a layer or change its visibility](https://docs.mapxagent.com/api-reference/layers/rename-a-layer-or-change-its-visibility.md): Requires scope: layers. Only the provided fields are updated. - [Reorder all layers in one request](https://docs.mapxagent.com/api-reference/layers/reorder-all-layers-in-one-request.md): Requires scope: layers. Atomically replaces the project's layer draw order. layer_ids must contain exactly the current set of layer ids of the project; the first id is rendered on top. An empty or non-permutation array is rejected with 400. - [Update a layer style](https://docs.mapxagent.com/api-reference/layers/update-a-layer-style.md): Requires scope: layers. Partial style update with merge semantics: the given style is merged into the layer's persisted style, so omitted top-level keys are preserved, a same-type renderer deep-merges its paint, and label/legend are merged. #### Reports - [Save an HTML report](https://docs.mapxagent.com/api-reference/reports/save-an-html-report.md): Requires scope: reports. The HTML is stored as a project file (max 2MB). - [Get report metadata](https://docs.mapxagent.com/api-reference/reports/get-report-metadata.md): Requires scope: reports. #### API Keys - [List API keys](https://docs.mapxagent.com/api-reference/api-keys/list-api-keys.md): Requires scope: keys. Raw keys are never returned. - [Create an API key](https://docs.mapxagent.com/api-reference/api-keys/create-an-api-key.md): Requires scope: keys. The raw key is returned only once. - [Revoke an API key](https://docs.mapxagent.com/api-reference/api-keys/revoke-an-api-key.md): Requires scope: keys. Revoked keys stop working immediately. #### Authentication - [Verify the API key](https://docs.mapxagent.com/api-reference/authentication/verify-the-api-key.md): No scope required. Returns the account user id, key id, and granted scopes for the current Bearer key. #### Usage - [Get current plan usage](https://docs.mapxagent.com/api-reference/usage/get-current-plan-usage.md): Requires scope: session. Returns AI call and storage usage for the current period. #### Meta - [Get the OpenAPI specification](https://docs.mapxagent.com/api-reference/meta/get-the-openapi-specification.md): Public — no API key required. ### Client - [mapx CLI](https://docs.mapxagent.com/en/developers/mapx-cli.md): Drive MapX projects, data, styles, and reports from third-party platforms with the mapx command-line client. ## OpenAPI Specs - [openapi](/openapi.json) - [openapi](/source/openapi.json) > The links below point to documentation indexes. Follow each `/_llms/` index recursively until you reach documentation pages. ## Indexes - [Chinese (66 pages)](https://docs.mapxagent.com/_llms/zh.md): Documentation for Chinese. This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.