Getting an API key
How to create, view, and revoke API keys for programmatic access to MapVS.
Authenticating requests
Include your API key as a Bearer token on every request. Here's the exact format.
Rate limits
Per-key limits, headers to inspect, and how to back off gracefully.
Errors and status codes
The complete list of status codes and error envelope format returned by the MapVS API.
Pagination
List endpoints paginate. Learn the query parameters and how to iterate cleanly.
Maps endpoints
Full reference for /api/v1/maps - list, get, create, delete, and search.
Stages endpoints
Reference for /api/v1/maps/{id}/stages - add, update, and reorder stages within a map.
Recordings endpoints
Reference for /api/v1/maps/{id}/recording and /api/v1/recording/new - the primary write paths.
Runs endpoints
Reference for /api/v1/maps/{id}/runs - list, get, compare, and delete runs.
Webhooks
Configure webhook endpoints that fire on MapVS events. Payloads, signing, and retry semantics.
SDKs
Official and community SDKs for calling the MapVS API from your language of choice.
API changelog
Breaking changes, new endpoints, and deprecations for the /api/v1 surface.