Mapbox Nav Directions Get Directions
1.6 credits/call
ae_mapbox_nav_directions_get_directions
Get turn-by-turn directions and optimal routes for driving, walking, cycling, or electric vehicles.
1.6 credits/call
Pricing
1.6 credits/call
| Condition | Charge |
|---|---|
| Each call | 1.6 credits/call |
Parameters
Optional parameters use the platform defaults when omitted.
| Parameter | Type | Required | Description | Default |
|---|---|---|---|---|
steps | boolean | No | Whether to return steps and turn-by-turn instructions. | — |
layers | string | No | Influences the layer of road from which a route starts from a waypoint. | — |
exclude | string | No | Exclude certain road types and custom locations from routing. | — |
include | string | No | Include certain additional road types for routing. | — |
profile | enum (mapbox/driving-traffic | mapbox/driving | mapbox/walking | mapbox/cycling) | Yes | The routing profile to use for calculating directions. | — |
bearings | string | No | Influences the direction in which a route starts from a waypoint. Format: {angle,degrees} per waypoint. | — |
language | string | No | The language of returned turn-by-turn text instructions. | — |
overview | enum (full | simplified | false) | No | Displays the requested type of overview geometry. | — |
radiuses | string | No | The maximum distance a coordinate can be moved to snap to the road network, in meters. | — |
arrive_by | string | No | The desired arrival time in ISO 8601 format (mapbox/driving profile only). | — |
depart_at | string | No | The departure time in ISO 8601 format (mapbox/driving and mapbox/driving-traffic profiles). | — |
max_width | number | No | The max vehicle width in meters. | — |
waypoints | string | No | A semicolon-separated list indicating which input coordinates should be treated as waypoints. | — |
alley_bias | number | No | A scale from -1 to 1 biasing route toward or against alleys (mapbox/driving profile only). | — |
approaches | string | No | A semicolon-separated list indicating the side of the road from which to approach waypoints. | — |
geometries | enum (geojson | polyline | polyline6) | No | The format of the returned geometry. | — |
max_height | number | No | The max vehicle height in meters. | — |
max_weight | number | No | The max vehicle weight in metric tons. | — |
annotations | string | No | Return additional metadata along the route. Must be used in conjunction with overview=full. | — |
coordinates | string | Yes | A semicolon-separated list of between two and 25 {longitude},{latitude} coordinate pairs to visit in order. | — |
voice_units | enum (imperial | british_imperial | metric) | No | Specify which type of units to return in voice instructions. | — |
alternatives | boolean | No | Whether to try to return alternative routes (true) or not (false, default). Up to two alternatives may be returned. | — |
walkway_bias | number | No | A scale from -1 to 1 biasing route toward or against walkways (mapbox/walking profile only). | — |
notifications | enum (all | none) | No | Returns notification metadata associated with the route leg. | — |
walking_speed | number | No | The walking speed in meters per second (mapbox/walking profile only). | — |
waypoint_names | string | No | A semicolon-separated list of custom names for entries in the coordinates list. | — |
roundabout_exits | boolean | No | Whether to emit instructions at roundabout exits. Must be used with steps=true. | — |
waypoint_targets | string | No | A semicolon-separated list of coordinate pairs used to specify drop-off locations. | — |
continue_straight | boolean | No | Sets the allowed direction of travel when departing intermediate waypoints. | — |
voice_instructions | boolean | No | Whether to return SSML marked-up text for voice guidance. Must be used with steps=true. | — |
banner_instructions | boolean | No | Whether to return banner objects associated with the route steps. Must be used with steps=true. | — |
waypoints_per_route | boolean | No | If true, the waypoints array is returned within the route object. | — |
avoid_maneuver_radius | integer | No | Add a radius around the starting point in which the API will avoid returning any significant maneuvers. Range: 1-1000 meters. | — |
snapping_include_closures | string | No | A semicolon-separated list of boolean values affecting snapping to road segments with live-traffic closures (mapbox/driving-traffic only). | — |
snapping_include_static_closures | string | No | A semicolon-separated list of boolean values affecting snapping to statically closed road segments (mapbox/driving-traffic only). | — |
Invocation example
Copy the request and explore its response example.
POST
/agent-api/v1/tool/executeX-Api-KeyRequest coderequest.sh
Response exampleresponse.json


