Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.footstep.ai/llms.txt

Use this file to discover all available pages before exploring further.

Calculate a route and search for places along the corridor. Results are ranked by how little detour they add to your journey. Useful for finding stops on the way to a destination without going too far off course. You can set the maximum acceptable detour (1 minute to 1 hour) to control how far off-route results can be.

​
Example prompts

  • “Find coffee shops on my way from Kings Cross to Cambridge”
  • “Are there any petrol stations along the route that won’t add more than 5 minutes?”
  • “Show me restaurants between here and the airport with minimal detour”
  • “What supermarkets can I stop at on my drive to Oxford?”

​
What you get back

A list of places found along the corridor plus the route’s totals (distance, duration, terrain). Each place includes the detour it would add (in seconds and meters), and where along the route it sits (as a percentage from start to end). Results are ranked by detour time so the most convenient stops come first. When all candidate places share the same country / region (the typical case for an in-corridor search), those fields are hoisted to a top-level places_context object instead of being repeated on every place.

​
Map rendering

Responses include a render envelope with a linestring layer for the route plus a point layer for the candidate places. Pass compact: true for summary-only responses (route summary fields and candidate places only). See response defaults & controls and render envelopes.

​
Example response

{
  "structuredContent": {
    "route": { "distance_meters": 24000, "duration_seconds": 1500 },
    "places": [
      { "place": { "name": "Costa", "label": "Costa, Cambridge Services", "coordinates": { "lat": 52.05, "lng": 0.10 } }, "detour_seconds": 90 }
    ],
    "render": [
      { "kind": "linestring", "label": "Route", "data": {/* GeoJSON */}, "bbox": [/* … */] },
      {
        "kind": "point",
        "label": "Matched places",
        "data": {
          "type": "FeatureCollection",
          "features": [
            { "type": "Feature", "geometry": {/* Point */}, "properties": { "name": "Costa", "detour_seconds": 90 } }
          ]
        },
        "bbox": [/* … */]
      }
    ]
  }
}