POST/v1/clearance/along

API key required, sent as Authorization: Bearer snk_… or ?api_key=snk_….

Call it

bash

curl -fsS -X POST "https://api.mapmap.ai/v1/clearance/along" \
  -H "Authorization: Bearer $MAPMAP_KEY" \
  -H "Content-Type: application/json" \
  -d @request.json

Request body

application/json · ClearanceAlongRequest

Route shape as polyline6 plus the vehicle's height in metres (optional width, operating margin and dataset narrowing)

Field	Type	Required	Description
datasets	string[]	no	Narrow the search to these datasets. The default is every dataset this key may see whose survey covers the corridor. A name this key may not see, or that does not exist, is dropped: the answer is the same "not surveyed" either way.
geometry_polyline6	string	yes	The corridor as a Google encoded polyline, six-digit precision — typically `geometry_polyline6` from a prior `/route` response. Capped at 10,000 vertices.
margin_m	number	no	The caller's operating margin in metres, added to the height. Defaults to zero, and is echoed back: no compliance policy is baked in here, both figures are reported.
vehicle_height_m	number	yes	Vehicle height in metres. Required: there is no default vehicle.
vehicle_width_m	number	no	Vehicle width in metres. The width axis is assessed only when this is given; without it the report answers for height and says so.

Responses

200The clearance report: verdict per axis, limiting point with its bound, coverage, datasets read

Field	Type	Required	Description
advisories	Advisory[]	yes	Notes on stretches of the route.
basis	string	yes	Always `surveyed_geometry_not_signage`.
clearance_enforcement	ClearanceEnforcement	yes	The honesty block.
datasets	DatasetRef[]	yes	The datasets drawn on.
explanation	string	yes	One-line honest summary. British English, no claim words, no em dashes; see `explain.rs`, which enforces that rather than asking.
height	RouteVerdictOut	yes	The height axis.
route	RouteRef	yes	The route the question was asked about.
vehicle	VehicleQuery	yes	The vehicle, echoed back including its margin.
width	WidthOut	yes	The width axis.

400Invalid request

401Missing or invalid API key

429Quota or rate limit exceeded

501No clearance artefacts are configured on this deployment

Error bodies follow the shared problem model documented on API conventions.

Generated from https://api.mapmap.ai/openapi.json on 2026-09-17 · operationId post_clearance_along