# Sarkoa

> Sarkoa hosts geospatial data and serves it as maps. You upload a vector or raster
> file, Sarkoa builds a cloud-optimized copy of it (PMTiles for vectors, Cloud
> Optimized GeoTIFF for rasters), and you view, share, embed, or query the result.
> Your original stays stored unchanged and downloadable byte for byte.

Agents connect over a hosted MCP server and act on a real organization: files and
folders, uploads, custom maps and styling, time series, review comments, webhooks,
and queries against hosted vector layers and the raster catalogue.

- MCP endpoint (Streamable HTTP, `Authorization: Bearer <api_key>`): https://mcp.sarkoa.com/mcp
- MCP registry name: `com.sarkoa/mcp`
- Public API OpenAPI document: https://app.sarkoa.com/openapi/sarkoa-public-api.json
- API keys: created in the web app under Profile → API & Integrations (library, maps, queries, webhooks) or API Routes (tiles and metadata on the public API)

Start with Introduction and Concepts. For agent integration specifically, read MCP
then Feature query and Webhooks.

## Getting started

- [Introduction](https://sarkoa.com/docs/introduction/): What Sarkoa is, who it is for, and how clients connect to the platform.
- [Quick start](https://sarkoa.com/docs/quick-start/): Use a tiny licensed sample to upload, save and share a three-point map.
- [Reference projects](https://sarkoa.com/docs/reference-projects/): Reproduce demonstration GIS delivery workflows using licensed synthetic samples.
- [Concepts](https://sarkoa.com/docs/concepts/): Organizations, files, folders, supported formats, and the difference between your original and the map copy.

## Using Sarkoa

- [Web app](https://sarkoa.com/docs/web-app/): Uploading, organizing, viewing, and sharing geospatial data in the Sarkoa web app.
- [Sharing and access](https://sarkoa.com/docs/sharing-and-access/): The four ways to give someone access to a file or a map in Sarkoa, and how to pick between them.
- [Custom maps](https://sarkoa.com/docs/custom-maps/): Build a map from your files in the Sarkoa web app: layers, styling, legends, filters, and publishing.
- [Map menu and measuring](https://sarkoa.com/docs/map-menu/): Right-click or press and hold a hosted or embedded map for coordinates, a link to the spot, raster values and the measure tool, with 3D measuring, cross-sections and elevation profiles.
- [Embeds](https://sarkoa.com/docs/embeds/): Putting a Sarkoa map on your own website, and the options for controlling how it looks.
- [Listing in Explore](https://sarkoa.com/docs/explore/): Put a public map in Explore, Sarkoa's public directory of maps, and take it out again.
- [Printing maps](https://sarkoa.com/docs/printing/): Print a Sarkoa map as a georeferenced PDF from the map viewer, and prepare print layouts from the CLI, an AI agent, or the API.
- [Collaboration](https://sarkoa.com/docs/collaboration/): Comments, live annotations, downloads, and contributor uploads on a Sarkoa map.
- [Time series](https://sarkoa.com/docs/time-series/): Two ways to put time on a Sarkoa map: a series of dated files, or a timeline inside one file.
- [Animated flow](https://sarkoa.com/docs/animated-flow/): Make line layers flow with moving comets, and run particles through wind and current rasters, on hosted maps, embeds and the in-app viewer.
- [Weather and climate files](https://sarkoa.com/docs/weather-files/): Upload GRIB and NetCDF files from weather and ocean models, choose the fields to map, and turn wind into moving particles.
- [3D models (glTF)](https://sarkoa.com/docs/3d-models/): Upload a glTF or GLB model, place it on a map in the builder, colour 3D Tiles by a property, and show them on hosted maps, embeds and the in-app viewer.
- [Map tours](https://sarkoa.com/docs/tours/): Turn a map into a guided story. A tour flies the camera from stop to stop, with a caption at each, and can switch layers and move the time slider as it goes.
- [Swipe and side-by-side compare](https://sarkoa.com/docs/compare/): Show two versions of a map at once, cut by a divider readers can drag or side by side, each with its own layers and its own point in time.
- [Visualizations](https://sarkoa.com/docs/visualizations/): Draw a vector layer as arcs, moving trips, hexagon bins, a heatmap, columns, paths or points, coloured by a property and drawn at height, on hosted maps, embeds and the in-app viewer.
- [Contour lines](https://sarkoa.com/docs/contour-lines/): Draw contour lines over an elevation raster, or over the terrain of any map, on hosted maps, embeds, prints and the in-app viewer.
- [File optimization](https://sarkoa.com/docs/file-optimization/): What Sarkoa does to a file after you upload it, the 10 GiB limit, and how to control the way rasters display.
- [Feature query](https://sarkoa.com/docs/feature-query/): Query hosted vector layers by bounding box and attributes, read raster values at a point, and search the raster catalogue, without downloading files.

## Integrations

- [Authentication](https://sarkoa.com/docs/authentication/): Web sign-in and API keys for the app, CLI, and public API.
- [CLI](https://sarkoa.com/docs/cli/): Install and use the Sarkoa command-line tool.
- [QGIS plugin](https://sarkoa.com/docs/qgis-plugin/): Install and use the Sarkoa QGIS dock for upload, view, and download.
- [MCP (AI agents)](https://sarkoa.com/docs/mcp/): Connect AI agents to Sarkoa with the hosted Model Context Protocol server.
- [Skills (AI agents)](https://sarkoa.com/docs/skills/): Optional agent skill pack that teaches how to use Sarkoa MCP and CLI.
- [Map documents](https://sarkoa.com/docs/map-documents/): Author custom maps with a versioned JSON document from the CLI, MCP, or API.
- [Webhooks](https://sarkoa.com/docs/webhooks/): Receive signed events when files finish processing, instead of polling for status.
- [API reference](https://sarkoa.com/docs/api-reference/): The two Sarkoa HTTP surfaces, which host serves what, and the public tile, metadata and raster value API.

## Reference

- [Troubleshooting](https://sarkoa.com/docs/troubleshooting/): The things that go wrong most often in Sarkoa, and what to do about each one.
- [Tile requests](https://sarkoa.com/docs/tile-requests/): What counts as a tile request, how Sarkoa bills them, and how to estimate monthly usage.
- [Pricing and plans](https://sarkoa.com/docs/pricing-and-plans/): Sarkoa Free, Community, Essential, Pro, and Enterprise tiers.
- [Data trust and lifecycle](https://sarkoa.com/docs/data-trust/): Understand storage, sharing, deletion and questions to resolve before a professional delivery.
- [System status](https://sarkoa.com/docs/system-status/): How Sarkoa publishes measured production availability and what the status page covers.
- [Support and contact](https://sarkoa.com/docs/support-and-contact/): How to get help with Sarkoa.

## Optional

- [Documentation index](https://sarkoa.com/docs/): every page above, grouped, with a short note on each
- [FAQ](https://sarkoa.com/faq): billing, formats, security, and integrations
- [Pricing](https://sarkoa.com/pricing): current plan numbers and a usage estimator
- [Fair Use Policy](https://sarkoa.com/fair-use-policy): tile guidelines on paid unlimited plans
- [Community Guidelines](https://sarkoa.com/community-guidelines): what may be listed in Explore, the public map directory, and how reports are handled
- [Status](https://status.sarkoa.com): measured production availability