Directions

Route between two or more points

Generated from OpenAPI
POST
/directions

Calculates a route across the Rwandan road network, honouring terrain, surface and engine-supported access restrictions. Published local road operations are not yet served.

Cost: 1 credit for up to 10 waypoints, plus 1 credit for each additional 10.

Authorization

apiKey
headerAuthorizationBearer <token>

Send your key as Authorization: Bearer sk_live_….

Secret keys (sk_) are for server-side use and must never be exposed in a browser or a mobile binary. Browser or mobile use of secret keys is unsupported. Use your server to call these endpoints.

Request Body

application/json
  1. body
coordinates*array<array<any>>

Waypoints in visiting order, starting with the origin.

Items2 <= items <= 50
profile?Profile

The vehicle and behaviour model used for costing. moto is the motorcycle-taxi profile and the one most Rwandan traffic actually uses.

Default"car"
Example"moto"
Value in"moto""car""truck""bicycle""pedestrian""pedestrian_loaded"
departure_time?string

Departure time. Supplying it applies time-conditioned restrictions such as bus lanes and market-day closures. Defaults to now.

Formatdate-time
Example"2026-09-02T07:15:00+02:00"
alternatives?integer

Number of alternative routes to return in addition to the best one.

Range0 <= value <= 3
Default1
geometry_format?string

Encoding of the returned route geometry.

Default"polyline6"
Value in"polyline6""geojson"
include_steps?boolean

Include turn-by-turn maneuver steps in each route leg.

Defaultfalse

Response Body

A route was found.

application/json
  1. response

Fields present on every successful response.

request_id*string

Unique id for this request. Quote it in any support conversation.

Lengthlength <= 64
Example"req_01JBQ7Z9Y4K2M3N4P5Q6R7S8T9"
credits_charged*integer

Credits deducted from the account balance for this request.

Range0 <= value
Example1
data_version*string

The data release that answered this request.

Lengthlength <= 32
Example"2026-09-02T03"
profile*Profile

The vehicle and behaviour model used for costing. moto is the motorcycle-taxi profile and the one most Rwandan traffic actually uses.

Default"car"
Example"moto"
Value in"moto""car""truck""bicycle""pedestrian""pedestrian_loaded"
routes*array<>

Best route first, followed by requested alternatives.

Items1 <= items <= 4
curl -X POST 'https://api.uat.audisory.com/v1/directions' \  -H 'Authorization: Bearer YOUR_API_KEY' \  -H 'Content-Type: application/json' \  -d '{  "coordinates": [    [      30.0619,      -1.9441    ],    [      30.1395,      -1.9686    ]  ],  "profile": "moto"}'
{  "request_id": "req_01JBQ7Z9Y4K2M3N4P5Q6R7S8T9",  "credits_charged": 1,  "data_version": "2026-09-02T03",  "profile": "moto",  "routes": [    {      "id": 0,      "summary": {        "distance_m": 12480,        "duration_s": 1320      },      "elevation": {        "ascent_m": 142,        "descent_m": 38,        "max_grade": 0.09      },      "traffic_confidence": "low",      "geometry": "zpq}Ao~ihE...",      "legs": [        {          "distance_m": 12480,          "duration_s": 1320        }      ]    }  ]}

Try this API in your console playground →