{"utcp_version":"1.0.1","manual_version":"1.0.0","tools":[{"name":"optimize_route","description":"Put the stops of a route in a shorter order and get an arrival time for each. Counts as one optimization of the account's day on the free plan.","inputs":{"type":"object","properties":{"body":{"properties":{"start":{"properties":{"lat":{"description":"Latitude in degrees, -90 to 90.","examples":[25.2048],"maximum":90,"minimum":-90,"title":"Lat","type":"number"},"lon":{"description":"Longitude in degrees, -180 to 180.","examples":[55.2708],"maximum":180,"minimum":-180,"title":"Lon","type":"number"},"name":{"default":"","description":"Optional label for the place.","maxLength":120,"title":"Name","type":"string"}},"required":["lat","lon"],"title":"ApiPlace","type":"object","description":"Where the route starts."},"end_mode":{"default":"round_trip","description":"round_trip returns to the start; open ends at the last stop.","enum":["round_trip","open"],"title":"End Mode","type":"string"},"departure":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"default":null,"description":"Departure time (ISO-8601 with offset). Defaults to now.","title":"Departure"},"profile":{"default":"car","description":"How the route is travelled.","enum":["car","bike","walk"],"title":"Profile","type":"string"},"stops":{"description":"The stops, in any order.","items":{"properties":{"id":{"anyOf":[{"maxLength":64,"minLength":1,"type":"string"},{"type":"null"}],"default":null,"description":"Your own id for the stop (1 to 64 characters, unique in the request). Generated as stop-1, stop-2 and so on when left out.","title":"Id"},"name":{"default":"","description":"Optional name, returned unchanged.","maxLength":120,"title":"Name","type":"string"},"address":{"default":"","description":"Optional address, returned unchanged.","maxLength":200,"title":"Address","type":"string"},"lat":{"description":"Latitude in degrees.","maximum":90,"minimum":-90,"title":"Lat","type":"number"},"lon":{"description":"Longitude in degrees.","maximum":180,"minimum":-180,"title":"Lon","type":"number"},"service_s":{"default":0,"description":"Seconds spent at the stop.","maximum":86400,"minimum":0,"title":"Service S","type":"integer"},"window":{"anyOf":[{"properties":{"start":{"format":"date-time","title":"Start","type":"string"},"end":{"format":"date-time","title":"End","type":"string"}},"required":["start","end"],"title":"TimeWindow","type":"object"},{"type":"null"}],"default":null,"description":"Time window {start, end} (ISO-8601 with offset). Needs Pro."},"priority":{"default":"normal","description":"Visit this stop first or last. Needs Pro.","enum":["normal","first","last"],"title":"Priority","type":"string"}},"required":["lat","lon"],"title":"ApiStop","type":"object"},"minItems":1,"title":"Stops","type":"array"}},"required":["start","stops"],"type":"object"}},"required":["body"]},"outputs":{"properties":{"stops":{"description":"The stops in the order to visit them.","items":{"properties":{"id":{"title":"Id","type":"string"},"name":{"title":"Name","type":"string"},"address":{"title":"Address","type":"string"},"lat":{"title":"Lat","type":"number"},"lon":{"title":"Lon","type":"number"},"eta":{"description":"Arrival time (ISO-8601).","title":"Eta","type":"string"},"departure":{"description":"Time of leaving the stop (ISO-8601).","title":"Departure","type":"string"},"distance_m":{"description":"Metres from the previous point.","title":"Distance M","type":"integer"},"duration_s":{"description":"Seconds of travel from the previous point.","title":"Duration S","type":"integer"},"wait_s":{"description":"Seconds waited for a time window to open.","title":"Wait S","type":"integer"},"late_s":{"description":"Seconds after the end of the time window (0 when on time).","title":"Late S","type":"integer"}},"required":["id","name","address","lat","lon","eta","departure","distance_m","duration_s","wait_s","late_s"],"title":"RouteStop","type":"object"},"title":"Stops","type":"array"},"start":{"properties":{"lat":{"description":"Latitude in degrees, -90 to 90.","examples":[25.2048],"maximum":90,"minimum":-90,"title":"Lat","type":"number"},"lon":{"description":"Longitude in degrees, -180 to 180.","examples":[55.2708],"maximum":180,"minimum":-180,"title":"Lon","type":"number"},"name":{"default":"","description":"Optional label for the place.","maxLength":120,"title":"Name","type":"string"}},"required":["lat","lon"],"title":"ApiPlace","type":"object"},"end_mode":{"enum":["round_trip","open"],"title":"End Mode","type":"string"},"profile":{"enum":["car","bike","walk"],"title":"Profile","type":"string"},"departure":{"title":"Departure","type":"string"},"return_leg":{"anyOf":[{"properties":{"distance_m":{"title":"Distance M","type":"integer"},"duration_s":{"title":"Duration S","type":"integer"}},"required":["distance_m","duration_s"],"title":"ReturnLeg","type":"object"},{"type":"null"}],"description":"The way back to the start; null for an open route."},"total_distance_m":{"title":"Total Distance M","type":"integer"},"total_duration_s":{"title":"Total Duration S","type":"integer"},"finish":{"description":"When the route ends (ISO-8601).","title":"Finish","type":"string"},"savings":{"properties":{"distance_m":{"description":"Metres saved compared with the order you sent. Never negative.","title":"Distance M","type":"integer"},"duration_s":{"description":"Seconds of travel saved. Never negative.","title":"Duration S","type":"integer"},"percent_shorter":{"description":"Percent of the distance saved.","title":"Percent Shorter","type":"number"},"meaningful":{"description":"True when at least 3 percent and 300 m were saved.","title":"Meaningful","type":"boolean"}},"required":["distance_m","duration_s","percent_shorter","meaningful"],"title":"Savings","type":"object"},"solver":{"title":"Solver","type":"string"},"matrix":{"description":"osrm for road distances, haversine for the built-in model (estimates).","title":"Matrix","type":"string"},"usage":{"properties":{"plan":{"enum":["free","pro"],"title":"Plan","type":"string"},"limits":{"properties":{"max_stops":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Stops per route, or null (no limit of the plan).","title":"Max Stops"},"stops_ceiling":{"description":"Technical fair-use ceiling of stops per route, on every plan.","title":"Stops Ceiling","type":"integer"},"optimizations_per_day":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Optimizations per UTC day, or null (no limit of the plan).","title":"Optimizations Per Day"},"optimizations_left_today":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Optimizations Left Today"},"resets_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the daily count resets (ISO-8601), or null.","title":"Resets At"}},"required":["max_stops","stops_ceiling","optimizations_per_day","optimizations_left_today","resets_at"],"title":"UsageLimits","type":"object"},"used_today":{"description":"Optimizations counted today (UTC) for this account, in the apps and through the API.","title":"Used Today","type":"integer"},"requests_per_minute":{"description":"Requests a minute allowed per API key.","title":"Requests Per Minute","type":"integer"},"upgrade_url":{"title":"Upgrade Url","type":"string"}},"required":["plan","limits","used_today","requests_per_minute","upgrade_url"],"title":"UsageOut","type":"object"}},"required":["stops","start","end_mode","profile","departure","return_leg","total_distance_m","total_duration_s","finish","savings","solver","matrix","usage"],"type":"object"},"tags":["routing","optimization","logistics"],"tool_call_template":{"call_template_type":"http","name":"easyroute","url":"https://easyroute.ae/api/v1/optimize","http_method":"POST","content_type":"application/json","auth":{"auth_type":"api_key","api_key":"Bearer ${EASYROUTE_API_KEY}","var_name":"Authorization","location":"header"},"body_field":"body"}},{"name":"geocode_address","description":"Search for an address or place and get its name, address and coordinates.","inputs":{"properties":{"q":{"description":"Address or place to look for, 2 to 120 characters.","examples":["Dubai Mall"],"title":"Q","type":"string"},"limit":{"default":5,"description":"How many results to return.","maximum":8,"minimum":1,"title":"Limit","type":"integer"},"lat":{"anyOf":[{"maximum":90,"minimum":-90,"type":"number"},{"type":"null"}],"default":null,"description":"Bias results towards this latitude (give lon too).","title":"Lat"},"lon":{"anyOf":[{"maximum":180,"minimum":-180,"type":"number"},{"type":"null"}],"default":null,"description":"Bias results towards this longitude (give lat too).","title":"Lon"},"lang":{"anyOf":[{"maxLength":16,"type":"string"},{"type":"null"}],"default":null,"description":"Result language: en, de, fr or it.","title":"Lang"}},"required":["q"],"type":"object"},"outputs":{"properties":{"results":{"items":{"properties":{"name":{"title":"Name","type":"string"},"address":{"title":"Address","type":"string"},"lat":{"title":"Lat","type":"number"},"lon":{"title":"Lon","type":"number"}},"required":["name","address","lat","lon"],"title":"GeoPlace","type":"object"},"title":"Results","type":"array"}},"required":["results"],"type":"object"},"tags":["geocoding","address","search"],"tool_call_template":{"call_template_type":"http","name":"easyroute","url":"https://easyroute.ae/api/v1/geocode","http_method":"GET","content_type":"application/json","auth":{"auth_type":"api_key","api_key":"Bearer ${EASYROUTE_API_KEY}","var_name":"Authorization","location":"header"}}},{"name":"create_route_link","description":"Turn a route into a link a driver can open without an app or an account.","inputs":{"type":"object","properties":{"body":{"properties":{"title":{"default":"EasyRoute route","description":"Title shown on the link page.","maxLength":120,"title":"Title","type":"string"},"start":{"anyOf":[{"properties":{"name":{"default":"","maxLength":120,"title":"Name","type":"string"},"lat":{"maximum":90,"minimum":-90,"title":"Lat","type":"number"},"lon":{"maximum":180,"minimum":-180,"title":"Lon","type":"number"}},"required":["lat","lon"],"title":"HandoffStart","type":"object"},{"type":"null"}],"default":null,"description":"Where the route starts."},"end_mode":{"default":"round_trip","enum":["round_trip","open"],"title":"End Mode","type":"string"},"profile":{"default":"car","enum":["car","bike","walk"],"title":"Profile","type":"string"},"stops":{"description":"The stops in the order to drive them.","items":{"properties":{"id":{"anyOf":[{"maxLength":64,"minLength":1,"type":"string"},{"type":"null"}],"default":null,"description":"Your id for the stop; generated when left out.","title":"Id"},"name":{"default":"","maxLength":120,"title":"Name","type":"string"},"address":{"default":"","maxLength":200,"title":"Address","type":"string"},"lat":{"maximum":90,"minimum":-90,"title":"Lat","type":"number"},"lon":{"maximum":180,"minimum":-180,"title":"Lon","type":"number"},"note":{"default":"","maxLength":300,"title":"Note","type":"string"},"service_s":{"default":0,"maximum":86400,"minimum":0,"title":"Service S","type":"integer"},"eta":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"default":null,"description":"Planned arrival (ISO-8601 with offset).","title":"Eta"}},"required":["lat","lon"],"title":"LinkStop","type":"object"},"maxItems":1000,"minItems":1,"title":"Stops","type":"array"},"totals":{"anyOf":[{"properties":{"distance_m":{"maximum":100000000,"minimum":0,"title":"Distance M","type":"integer"},"duration_s":{"maximum":10000000,"minimum":0,"title":"Duration S","type":"integer"}},"required":["distance_m","duration_s"],"title":"HandoffTotals","type":"object"},{"type":"null"}],"default":null,"description":"Optional {distance_m, duration_s} shown on the page."}},"required":["stops"],"type":"object"}},"required":["body"]},"outputs":{"properties":{"id":{"title":"Id","type":"string"},"url":{"description":"Anyone with this address can open the route, without an app or an account.","title":"Url","type":"string"},"expires":{"title":"Expires","type":"string"}},"required":["id","url","expires"],"type":"object"},"tags":["routing","sharing"],"tool_call_template":{"call_template_type":"http","name":"easyroute","url":"https://easyroute.ae/api/v1/routes/link","http_method":"POST","content_type":"application/json","auth":{"auth_type":"api_key","api_key":"Bearer ${EASYROUTE_API_KEY}","var_name":"Authorization","location":"header"},"body_field":"body"}},{"name":"get_usage","description":"Show the plan of the account behind the API key, its limits and today's use.","inputs":{"type":"object","properties":{}},"outputs":{"properties":{"plan":{"enum":["free","pro"],"title":"Plan","type":"string"},"limits":{"properties":{"max_stops":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Stops per route, or null (no limit of the plan).","title":"Max Stops"},"stops_ceiling":{"description":"Technical fair-use ceiling of stops per route, on every plan.","title":"Stops Ceiling","type":"integer"},"optimizations_per_day":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Optimizations per UTC day, or null (no limit of the plan).","title":"Optimizations Per Day"},"optimizations_left_today":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Optimizations Left Today"},"resets_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the daily count resets (ISO-8601), or null.","title":"Resets At"}},"required":["max_stops","stops_ceiling","optimizations_per_day","optimizations_left_today","resets_at"],"title":"UsageLimits","type":"object"},"used_today":{"description":"Optimizations counted today (UTC) for this account, in the apps and through the API.","title":"Used Today","type":"integer"},"requests_per_minute":{"description":"Requests a minute allowed per API key.","title":"Requests Per Minute","type":"integer"},"upgrade_url":{"title":"Upgrade Url","type":"string"}},"required":["plan","limits","used_today","requests_per_minute","upgrade_url"],"type":"object"},"tags":["account","limits"],"tool_call_template":{"call_template_type":"http","name":"easyroute","url":"https://easyroute.ae/api/v1/usage","http_method":"GET","content_type":"application/json","auth":{"auth_type":"api_key","api_key":"Bearer ${EASYROUTE_API_KEY}","var_name":"Authorization","location":"header"}}}]}