routing

`POST /v1/route/heritage` (see module docs).

post/v1/route/heritage

Request

  • Base URL: https://api.mapmap.ai
  • URL: https://api.mapmap.ai/v1/route/heritage
  • Auth: one of:
    • HTTP bearer
    • API key in query parameter api_key

Request body

duration_snumber double nullable

The route's own duration in seconds, typically duration_s from the same response. Supply it: without it the silence budget falls back to a distance, and "three to five lines an hour" is a claim about time that a distance answers wrongly at both ends.

geometry_polyline6string required

The route shape as a Google encoded polyline, six-digit precision, typically geometry_polyline6 straight out of a prior /route response.

max_linesinteger nullable

Ceiling on how many lines come back (1 to 50, default 12).

max_offset_mnumber double nullable

How near a plaque's own recorded coordinate must come to the route before its line may be spoken, metres (default 60, hard ceiling 80). Past about eighty metres the subject stops being something the driver is passing, so the ceiling cannot be lifted from a request body.

min_gap_mnumber double nullable

Least distance between two spoken lines, metres (default 400). A floor under the time budget in every case, and the whole budget when no duration is supplied.

min_gap_snumber double nullable

Least time between two spoken lines, seconds (default 900, which is four an hour). Applied only when duration_s is given.

voice_formatstring nullable

Container to give each line's audio clip address in: opus (Android) or m4a (iOS). Given, every line gains a clip with the synthesis cache key and the URL to fetch it from. Omitted, no clip is computed and the answer is text only.

Response

Lines in route order, each with at_m, the say sentence, the measured offset_m from the plaque's own coordinate to the route, the plaque_ids the claim rests on, and (when voice_format was given) the clip that speaks it; plus a census of what was not said, the attribution the source dataset is owed, and the standing caveat

object required

Changes

No recorded changes to this operation across all 1 revision of this API.