road-trip-planner

Creates a road trip on Stopful, or updates one plotted earlier, and returns an interactive map of it — adding, removing, reordering or renaming stops, changing nights, dates or party size, and redrawing the route. Renders a multi-stop driving route as an interactive map and returns a link to it, plus an inline map in clients that support one. Takes a list of stops in driving order, each with a place name, optional decimal lat/lon and number of nights; a stop without coordinates is geocoded from its name, and coordinates that fall far from where the name resolves are reported back in the result. Accepts an optional trip name, start date, party size, and a day-by-day itinerary that becomes a day view over the map. The map shows per-leg drive times and distances and an estimate of what the trip will cost before anything is booked, and is editable: the traveller can drag a pin to move a stop or drag the route to add one, and their changes are saved to the trip. Covers road trips and other multi-stop routes; a single destination or a route with no stops to draw has nothing to render. The result contains the map link, the trip as structured data, and the trip's `id` (see the `id` parameter for updating an existing trip).

{
  "type": "object",
  "properties": {
    "stops": {
      "type": "array",
      "description": "The route in driving order, 1 to 40 entries (the first is the origin). Required for a normal call — the only call that omits it is `id` on its own, which re-reads a saved trip unchanged. Each entry needs `name`; every other field is optional. A stop is a place the traveller sleeps, or a place on the road between two such places. An outing made from a base — a waterpark, a market, a cave, a viewpoint visited from the hotel and returned from the same day — is NOT a stop: put it under `days` as that day's activity, and do not repeat the base between outings. Outings sent as stops are moved under their day.",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Optional. The id this stop was given in an earlier result. Echoing it back identifies that exact stop even if you rename it, so the traveller's placement and edits follow the right stop. Leave it out for a stop you are adding."
          },
          "name": {
            "type": "string",
            "description": "Real, searchable place name — a town, city or famous landmark (e.g. 'Sirmione', 'Colosseum'). A vague or descriptive phrase may fail to geocode."
          },
          "sub": {
            "type": "string",
            "description": "Optional short qualifier for disambiguation (e.g. region or country)."
          },
          "lat": {
            "type": "number",
            "description": "Optional decimal latitude. On a NEW stop, supplying it is faster and more exact than geocoding the name. On a stop that already exists (one you are sending an `id` for), leave lat/lon out unless you mean to move it — the stop keeps wherever it currently sits, including anywhere the traveller has dragged it. Coordinates sent for an existing stop are an instruction to move it there."
          },
          "lon": {
            "type": "number",
            "description": "Optional decimal longitude. Same as lat: give it for a new stop, and leave it out for an existing one unless the point of the call is to move that stop."
          },
          "nights": {
            "type": "integer",
            "description": "Optional. Nights at this stop: 0 = a pass-through on the drive (somewhere the route goes through without staying), 1 or more = overnight. Defaults to 1 when absent. A place visited from a base and returned from is an activity under `days`, not a 0-night stop."
          },
          "arriveBy": {
            "type": "string",
            "enum": [
              "drive",
              "flight",
              "train",
              "bus"
            ],
            "description": "Optional. How the traveller reaches this stop from the previous one. Defaults to a road leg (drive) when absent; 'flight' marks a real flight leg between two stops."
          }
        },
        "required": [
          "name"
        ]
      }
    },
    "id": {
      "type": "string",
      "description": "Id of a trip returned by an earlier call. SEND IT whenever this call is about a trip already plotted in this conversation — showing one of its days, fixing a stop, changing the route. WITHOUT `id` a separate new trip is created and the traveller is left with a pile of near-duplicate maps instead of one they can follow. With it the map link stays the same and their own edits survive. To change an existing trip, send its `id` together with the COMPLETE new `stops` and `days`; there are no partial updates. The map link then stays the same, and edits the traveller made on the map survive. Stops: a re-sent stop keeps the position they dragged it to, stops or waypoints they added on the map but absent from `stops` are kept, and a stop that was there before and is now omitted is removed. Activities: a re-sent one keeps its identity and the place, price and booking it carries on the map, which this tool does not report and so cannot be sent back; an activity the traveller added themselves is kept whether or not it appears here; one this tool showed earlier and now omitted is removed. Without an `id` a separate new trip is created and none of that carries over. Sending `id` with no `stops` is also accepted and changes nothing — it returns the trip exactly as saved."
    },
    "focusDay": {
      "type": "integer",
      "description": "Optional. Open the map on this day of the itinerary, 1 = the first day. The map shows ONE DAY at a time: the chosen day's stops, activities and driving, with the rest of the route greyed. Use it WITH `id` to answer 'show me day 3' about a trip already plotted — that gives the traveller one map they can page through instead of a new map per day. Omitted, the map opens on the day the trip is actually on (day 1 before it starts), and the traveller can switch day or ask for the whole route from the map itself."
    },
    "name": {
      "type": "string",
      "description": "Optional trip name (e.g. 'Lisbon → Pyrenees'). Defaults to first → last stop."
    },
    "startDate": {
      "type": "string",
      "description": "Optional trip start as ISO yyyy-mm-dd."
    },
    "guests": {
      "type": "object",
      "description": "Optional party size.",
      "properties": {
        "adults": {
          "type": "integer",
          "description": "Number of adults (default 2)."
        },
        "childrenAges": {
          "type": "array",
          "items": {
            "type": "integer"
          },
          "description": "Age of each child, e.g. [7, 11]. Preferred over `children`, because hotel and ticket pricing depends on the ages."
        },
        "children": {
          "type": "integer",
          "description": "How many children, for when their ages aren't known. Ignored when `childrenAges` is given."
        }
      }
    },
    "days": {
      "type": "array",
      "description": "The day-by-day itinerary: one entry per calendar day of the trip, in order, each with a title and the day's activities. It renders as a tappable day view over the map, and selecting a day highlights that day's driving; the activities also become the trip's itinerary in the full Stopful planner, where the traveller can edit them. Send it when planning a trip, or when rewriting the itinerary — the day titles replace the saved ones wholesale, there are no partial day updates, while the activities under them are reconciled with what is saved rather than overwritten (see `id`). On a call that only changes the route of an existing trip, leaving `days` out keeps the saved itinerary untouched, which is usually what is wanted; the result echoes whatever is saved either way.",
      "items": {
        "type": "object",
        "properties": {
          "title": {
            "type": "string",
            "description": "Short day title, e.g. 'Over the Alps to Innsbruck'."
          },
          "summary": {
            "type": "string",
            "description": "Optional one-line what-to-expect for the day."
          },
          "items": {
            "type": "array",
            "description": "The day's plan, in order.",
            "items": {
              "type": "object",
              "properties": {
                "time": {
                  "type": "string",
                  "description": "Optional time or part of day, e.g. '9:00 AM' or 'Morning'."
                },
                "title": {
                  "type": "string",
                  "description": "The place or activity, e.g. 'Altstadt Salzburg'. Every outing from a base belongs here — this is the only place it should appear, never also in `stops`."
                },
                "note": {
                  "type": "string",
                  "description": "Optional one-line detail."
                },
                "lat": {
                  "type": "number",
                  "description": "Optional decimal latitude of the activity. Supplying lat and lon puts a numbered pin on the map for it; without them the activity is still listed under its day, just not placed. Send them for a real place, and leave them out for something that isn't one ('Pack a picnic', 'Drive south')."
                },
                "lon": {
                  "type": "number",
                  "description": "Optional decimal longitude of the activity."
                }
              },
              "required": [
                "title"
              ]
            }
          }
        }
      }
    }
  },
  "required": [
    "stops"
  ]
}

{
  "type": "object",
  "properties": {
    "url": {
      "type": "string",
      "description": "Link that opens this trip on the map at stopful.com."
    },
    "id": {
      "type": "string",
      "description": "The trip's id. Pass it back as the `id` argument to apply a later change to this same trip."
    },
    "focusDay": {
      "type": "integer",
      "description": "Set when the call asked for one day: the map opens on that day of the itinerary, 1 = the first day."
    },
    "trip": {
      "type": "object",
      "description": "The trip as rendered, after geocoding and (on a continuation) merging the traveller's own map edits.",
      "properties": {
        "id": {
          "type": "string",
          "description": "The trip's id — the same value as the top-level `id`."
        },
        "name": {
          "type": "string"
        },
        "startDate": {
          "type": "string",
          "description": "ISO yyyy-mm-dd, when one was given."
        },
        "maxKmPerDay": {
          "type": "number"
        },
        "guests": {
          "type": "object",
          "properties": {
            "adults": {
              "type": "integer"
            },
            "childrenAges": {
              "type": "array",
              "items": {
                "type": "integer"
              }
            }
          }
        },
        "stops": {
          "type": "array",
          "description": "Final stops in driving order, each with resolved coordinates.",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "description": "Stable id for this stop. Send it back as the stop's `id` when updating the trip, so this stop is recognised even under a different name."
              },
              "name": {
                "type": "string"
              },
              "sub": {
                "type": "string"
              },
              "lat": {
                "type": "number"
              },
              "lon": {
                "type": "number"
              },
              "nights": {
                "type": "integer"
              },
              "arriveBy": {
                "type": "string"
              },
              "waypoint": {
                "type": "boolean",
                "description": "True for a shaping point the traveller dragged out of the route line, not a destination."
              }
            },
            "required": [
              "name",
              "lat",
              "lon"
            ]
          }
        }
      },
      "required": [
        "name",
        "stops"
      ]
    },
    "days": {
      "type": "array",
      "description": "The day-by-day itinerary. Activities may include ones the traveller added in the planner rather than through this tool.",
      "items": {
        "type": "object"
      }
    },
    "assumed": {
      "type": "array",
      "description": "Stops placed from their name alone because no coordinates were given — approximate pins.",
      "items": {
        "type": "string"
      }
    },
    "warnings": {
      "type": "array",
      "description": "Stops whose supplied coordinates are far from where their name resolves, with the distance and the resolved position.",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string"
          },
          "km": {
            "type": "number"
          },
          "lat": {
            "type": "number"
          },
          "lon": {
            "type": "number"
          }
        }
      }
    },
    "keptByTraveller": {
      "type": "array",
      "description": "Stops left where the traveller placed them on the map, so the coordinates supplied in this call were not applied.",
      "items": {
        "type": "string"
      }
    },
    "unchanged": {
      "type": "boolean",
      "description": "True when the call only read the saved trip and changed nothing — an `id` sent with no `stops`."
    },
    "notFound": {
      "type": "array",
      "description": "Stops that were requested but could not be placed, so they are absent from the map and the route.",
      "items": {
        "type": "string"
      }
    }
  },
  "required": [
    "url",
    "trip"
  ]
}