BRAINIAC Route & Delivery Optimisation is an MCP server published by software.brainiac, hosted at www.brainiac.software. When last checked on 2026-11-21 it was working: it answers and lists its tools. It declares 15 tools, including route-optimization_distance-matrix, route-optimization_tsp-optimize, route-optimization_vrp-capacitated, route-optimization_vrp-time-windows, route-optimization_pickup-delivery.
Paid Route & Delivery Optimisation API via x402. Unpaid tool calls return 402.
1,073 connections through 4 shared values. Tap any node.
Squares are this server's values; dots are other servers sharing them. A shared address or publisher is a lead, not proof of a common operator.
Inferred from the host name and headers: what a server runs on, not who runs it.
Build a haversine distance and estimated duration matrix from caller coordinates with optional circuity and speed when planning routes or deliveries. Call with locations; optional circuity, speedKph, speedMps. Returns ids, distancesM, durationsS, and estimate. Carrying a payment-signature is not yet a charge. Settlement happens only on HTTP 2xx. HTTP 200 with status complete, partial, or failed is charged at the full listed price. HTTP 4xx/5xx are not charged. Keywords: when planning routes or deliveries, locations, circuity, speedKph, speedMps, ids, distancesM, durationsS, estimate, Great-circle distance and duration matrix, distance matrix.
| Parameter | Type | Description |
|---|---|---|
| circuity | number | circuity, number, from 1 to 3. Optional. |
| speedKph | number | speedKph, number. Optional. |
| speedMps | number | speedMps, number. Optional. |
| locations * | array | locations, array. Required. |
{
"name": "route-optimization_distance-matrix",
"title": "Great-circle distance and duration matrix",
"description": "Build a haversine distance and estimated duration matrix from caller coordinates with optional circuity and speed when planning routes or deliveries. Call with locations; optional circuity, speedKph, speedMps. Returns ids, distancesM, durationsS, and estimate. Carrying a payment-signature is not yet a charge. Settlement happens only on HTTP 2xx. HTTP 200 with status complete, partial, or failed is charged at the full listed price. HTTP 4xx/5xx are not charged. Keywords: when planning routes or deliveries, locations, circuity, speedKph, speedMps, ids, distancesM, durationsS, estimate, Great-circle distance and duration matrix, distance matrix.",
"inputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"locations"
],
"properties": {
"circuity": {
"type": "number",
"maximum": 3,
"minimum": 1,
"description": "circuity, number, from 1 to 3. Optional."
},
"speedKph": {
"type": "number",
"description": "speedKph, number. Optional.",
"exclusiveMinimum": 0
},
"speedMps": {
"type": "number",
"description": "speedMps, number. Optional.",
"exclusiveMinimum": 0
},
"locations": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"lat",
"lon"
],
"properties": {
"id": {
"type": "string",
"maxLength": 120,
"minLength": 1,
"description": "id, string, length 1 to 120. Required."
},
"lat": {
"type": "number",
"maximum": 90,
"minimum": -90,
"description": "lat, number, from -90 to 90. Required."
},
"lon": {
"type": "number",
"maximum": 180,
"minimum": -180,
"description": "lon, number, from -180 to 180. Required."
}
},
"description": "item, object. Required."
},
"description": "locations, array. Required."
}
}
},
"outputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"ids": {
"type": "array",
"items": {
"type": "string",
"description": "Item. String."
},
"description": "ids. Array."
},
"sources": {
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "url. String."
},
"source": {
"type": "string",
"description": "source. String."
},
"status": {
"type": "string",
"description": "status. String."
},
"retrievedAt": {
"type": "string",
"description": "retrievedAt. String."
}
},
"description": "item. Object.",
"additionalProperties": {}
},
"description": "sources. Array."
},
"estimate": {
"type": "boolean",
"description": "estimate. Boolean."
},
"distancesM": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "number",
"description": "item. Number."
},
"description": "item. Array."
},
"description": "distancesM. Array."
},
"durationsS": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "number",
"description": "item. Number."
},
"description": "item. Array."
},
"description": "durationsS. Array."
},
"limitations": {
"type": "array",
"items": {
"type": "string",
"description": "Item. String."
},
"description": "limitations. Array."
}
},
"additionalProperties": {}
},
"annotations": {
"title": "Great-circle distance and duration matrix",
"readOnlyHint": true,
"openWorldHint": true,
"idempotentHint": true,
"destructiveHint": false
}
}Find a best visiting order for one vehicle (closed tour or open path) with fixed start and optional fixed end using Held-Karp or local search when planning routes or deliveries. Call with locations and start; optional matrix, matrixFromPoints, circuity, speedMps, speed, end and others. Returns sequence, totalDistance, totalDuration, method, optimal, estimate, and timeLimitMs. HTTP 200 with status complete, partial, or failed is charged at the full listed price. HTTP 4xx/5xx are not charged. Keywords: when planning routes or deliveries, locations, start, matrix, matrixFromPoints, circuity, speedMps, speed, end, objective, timeLimitMs, sequence, totalDistance, totalDuration, method.
| Parameter | Type | Description |
|---|---|---|
| end | any | end, value. Optional. |
| speed | number | speed, number. Optional. |
| start * | string | id, string, length 1 to 120. Required. |
| matrix | object | matrix, object. Optional. |
| circuity | number | circuity, number, from 1 to 3. Optional. |
| speedMps | number | speedMps, number. Optional. |
| locations * | array | locations, array. Required. |
| objective | string |
Assign stops to vehicles under capacity (and optional duration) limits, returning routes with loads and distances when planning routes or deliveries. Call with depot, stops, and vehicles; optional matrix, matrixFromPoints, circuity, speedMps, speed, maxRouteDuration and others. Returns routes, totalDistance, unassigned, method, optimal, estimate. HTTP 200 with status complete, partial, or failed is charged at the full listed price. HTTP 4xx/5xx are not charged. Keywords: when planning routes or deliveries, depot, stops, vehicles, matrix, matrixFromPoints, circuity, speedMps, speed, maxRouteDuration, minimise, timeLimitMs, routes, totalDistance, unassigned.
| Parameter | Type | Description |
|---|---|---|
| depot * | object | depot, object. Required. |
| speed | number | speed, number. Optional. |
| stops * | array | stops, array. Required. |
| matrix | object | matrix, object. Optional. |
| circuity | number | circuity, number, from 1 to 3. Optional. |
| minimise | string | minimise, string, one of distance, duration. Optional. |
| speedMps | number | speedMps, number. Optional. |
| vehicles * | array |
Route stops under customer time windows, service times, driver shifts and breaks with forward time propagation when planning routes or deliveries. Call with depot, stops, and vehicles; optional matrix, matrixFromPoints, circuity, speed, speedMps, minimise and others. Returns routes, unassigned, method, optimal, estimate, and timeLimitMs. HTTP 200 with status complete, partial, or failed is charged at the full listed price. HTTP 4xx/5xx are not charged. Keywords: when planning routes or deliveries, depot, stops, vehicles, matrix, matrixFromPoints, circuity, speed, speedMps, minimise, timeLimitMs, routes, unassigned, method, optimal.
| Parameter | Type | Description |
|---|---|---|
| depot * | object | depot, object. Required. |
| speed | number | speed, number. Optional. |
| stops * | array | stops, array. Required. |
| matrix | object | matrix, object. Optional. |
| circuity | number | circuity, number, from 1 to 3. Optional. |
| minimise | string | minimise, string, one of distance, completion_time, vehicles. Optional. |
| speedMps | number | speedMps, number. Optional. |
| vehicles * | array |
Route paired pickup-and-delivery requests with precedence, same-vehicle and capacity constraints when planning routes or deliveries. Call with depot, requests, and vehicles; optional matrix, matrixFromPoints, circuity, speed, timeLimitMs. Returns routes, unassigned, method, optimal, and estimate (routes includes vehicle, sequence, distance, maxLoad). HTTP 200 with status complete, partial, or failed is charged at the full listed price. HTTP 4xx/5xx are not charged. Keywords: when planning routes or deliveries, depot, requests, vehicles, matrix, matrixFromPoints, circuity, speed, timeLimitMs, routes, unassigned, method, optimal, estimate, Pickup and delivery routing.
| Parameter | Type | Description |
|---|---|---|
| depot * | object | depot, object. Required. |
| speed | number | speed, number. Optional. |
| matrix | object | matrix, object. Optional. |
| circuity | number | circuity, number, from 1 to 3. Optional. |
| requests * | array | requests, array. Required. |
| vehicles * | array | vehicles, array. Required. |
| timeLimitMs | integer | timeLimitMs, integer, from 1 to 25000. Optional. |
| matrixFromPoints |
Assign recurring visits across a horizon with frequency and spacing rules, then route each day when planning routes or deliveries. Call with horizonDays, stops, and depot; optional vehiclesPerDay, capacityPerDay, matrix, matrixFromPoints, timeLimitMs. Returns days, visitPatterns, and unassigned (days includes day, route, distance). HTTP 200 with status complete, partial, or failed is charged at the full listed price. HTTP 4xx/5xx are not charged. Keywords: when planning routes or deliveries, horizonDays, stops, depot, vehiclesPerDay, capacityPerDay, matrix, matrixFromPoints, timeLimitMs, days, visitPatterns, unassigned, Multi-day visit planning, multi day plan.
| Parameter | Type | Description |
|---|---|---|
| depot * | object | depot, object. Required. |
| stops * | array | stops, array. Required. |
| matrix | object | matrix, object. Optional. |
| horizonDays * | array | horizonDays, array. Required. |
| timeLimitMs | integer | timeLimitMs, integer, from 1 to 25000. Optional. |
| capacityPerDay | any | capacityPerDay, value. Optional. |
| vehiclesPerDay | integer | vehiclesPerDay, integer, from 1 to 100. Optional. |
| matrixFromPoints |
Split stops into k balanced, compact territories with capacitated k-means and imbalance limits when planning routes or deliveries. Call with stops and k; optional balanceBy, maxImbalance, matrixFromPoints, seed. Returns territories, imbalance, and withinSse (territories includes id, stops, size, centroid). HTTP 200 with status complete, partial, or failed is charged at the full listed price. HTTP 4xx/5xx are not charged. Keywords: when planning routes or deliveries, stops, balanceBy, maxImbalance, matrixFromPoints, seed, territories, imbalance, withinSse, Balanced territory clustering, territory cluster.
| Parameter | Type | Description |
|---|---|---|
| k * | integer | k, integer, from 1 to 500. Required. |
| seed | integer | seed, integer, from -9007199254740991 to 9007199254740991. Optional. |
| stops * | array | stops, array. Required. |
| balanceBy | string | balanceBy, string, one of count, weight. Optional. |
| maxImbalance | number | maxImbalance, number, from 0 to 1. Optional. |
| matrixFromPoints | string | matrixFromPoints, string, one of euclidean, haversine. Optional. |
Choose p hub locations from candidates to minimise demand-weighted distance, optionally capacitated when planning routes or deliveries. Call with demand, candidates, and p; optional matrix, matrixFromPoints, capacities. Returns selected, objective, allocation, method, and optimal (allocation includes demand, facility). HTTP 200 with status complete, partial, or failed is charged at the full listed price. HTTP 4xx/5xx are not charged. Keywords: when planning routes or deliveries, demand, candidates, matrix, matrixFromPoints, capacities, selected, objective, allocation, method, optimal, Depot / hub location (p-median), depot location optimize.
| Parameter | Type | Description |
|---|---|---|
| p * | integer | p, integer, from 1 to 100. Required. |
| demand * | array | demand, array. Required. |
| matrix | object | matrix, object. Optional. |
| candidates * | array | candidates, array. Required. |
| capacities | any | capacities, value. Optional. |
| matrixFromPoints | string | matrixFromPoints, string, one of euclidean, haversine. Optional. |
Compute arrivals, waits, slack and overtime for a fixed stop sequence with optional return and shift end when planning routes or deliveries. Call with start and sequence; optional returnTo, matrix, matrixFromPoints, speed, speedMps, shiftEnd. Returns stops, returnTime, overtime, violations, totalDistance, and estimate. HTTP 200 with status complete, partial, or failed is charged at the full listed price. HTTP 4xx/5xx are not charged. Keywords: when planning routes or deliveries, start, sequence, returnTo, matrix, matrixFromPoints, speed, speedMps, shiftEnd, stops, returnTime, overtime, violations, totalDistance, estimate.
| Parameter | Type | Description |
|---|---|---|
| speed | number | speed, number. Optional. |
| start * | object | start, object. Required. |
| matrix | object | matrix, object. Optional. |
| returnTo | object | returnTo, object. Optional. |
| sequence * | array | sequence, array. Required. |
| shiftEnd | number | shiftEnd, number. Optional. |
| speedMps | number | speedMps, number. Optional. |
| matrixFromPoints | string | matrixFromPoints, string, one of euclidean, haversine. Optional. |
Order parcels last-delivered-first and run a deterministic layer first-fit packing check in a van or truck box when planning routes or deliveries. Call with box and parcels; optional units. Returns loadingOrder, fits, volumeUtilisation, weightUtilisation, placements, and method (placements includes id, x, y, z, orientation). HTTP 200 with status complete, partial, or failed is charged at the full listed price. HTTP 4xx/5xx are not charged. Keywords: when planning routes or deliveries, box, parcels, units, loadingOrder, fits, volumeUtilisation, weightUtilisation, placements, method, Vehicle loading order and 3D fit, vehicle load sequence.
| Parameter | Type | Description |
|---|---|---|
| box * | object | box, object. Required. |
| units | string | units, string, length 1 to 32. Optional. |
| parcels * | array | parcels, array. Required. |
{
"name": "route-optimization_vehicle-load-sequence",
"title": "Vehicle loading order and 3D fit",
"description": "Order parcels last-delivered-first and run a deterministic layer first-fit packing check in a van or truck box when planning routes or deliveries. Call with box and parcels; optional units. Returns loadingOrder, fits, volumeUtilisation, weightUtilisation, placements, and method (placements includes id, x, y, z, orientation). HTTP 200 with status complete, partial, or failed is charged at the full listed price. HTTP 4xx/5xx are not charged. Keywords: when planning routes or deliveries, box, parcels, units, loadingOrder, fits, volumeUtilisation, weightUtilisation, placements, method, Vehicle loading order and 3D fit, vehicle load sequence.",
"inputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"box",
"parcels"
],
"properties": {
"box": {
"type": "object",
"required": [
"length",
"width",
"height",
"maxWeight"
],
"properties": {
"width": {
"type": "number",
"description": "width, number. Required.",
"exclusiveMinimum": 0
},
"height": {
"type": "number",
"description": "height, number. Required.",
"exclusiveMinimum": 0
},
"length": {
"type": "number",
"description": "length, number. Required.",
"exclusiveMinimum": 0
},
"maxWeight": {
"type": "number",
"description": "maxWeight, number. Required.",
"exclusiveMinimum": 0
}
},
"description": "box, object. Required."
},
"units": {
"type": "string",
"maxLength": 32,
"minLength": 1,
"description": "units, string, length 1 to 32. Optional."
},
"parcels": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"stopIndex",
"l",
"w",
"h",
"weight"
],
"properties": {
"h": {
"type": "number",
"description": "h, number. Required.",
"exclusiveMinimum": 0
},
"l": {
"type": "number",
"description": "l, number. Required.",
"exclusiveMinimum": 0
},
"w": {
"type": "number",
"description": "w, number. Required.",
"exclusiveMinimum": 0
},
"id": {
"type": "string",
"maxLength": 120,
"minLength": 1,
"description": "id, string, length 1 to 120. Required."
},
"weight": {
"type": "number",
"minimum": 0,
"description": "weight, number, from 0 to any. Required."
},
"rotatable": {
"type": "boolean",
"description": "rotatable, boolean. Optional."
},
"stopIndex": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0,
"description": "stopIndex, integer, from 0 to 9007199254740991. Required."
}
},
"description": "item, object. Required."
},
"description": "parcels, array. Required."
}
}
},
"outputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"fits": {
"type": "boolean",
"description": "fits. Boolean."
},
"method": {
"type": "string",
"description": "method. String."
},
"sources": {
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "url. String."
},
"source": {
"type": "string",
"description": "source. String."
},
"status": {
"type": "string",
"description": "status. String."
},
"retrievedAt": {
"type": "string",
"description": "retrievedAt. String."
}
},
"description": "item. Object.",
"additionalProperties": {}
},
"description": "sources. Array."
},
"placements": {
"type": "array",
"items": {
"type": "object",
"properties": {
"x": {
"type": "number",
"description": "x. Number."
},
"y": {
"type": "number",
"description": "y. Number."
},
"z": {
"type": "number",
"description": "z. Number."
},
"id": {
"type": "string",
"description": "id. String."
},
"orientation": {
"type": "string",
"description": "orientation. String."
}
},
"description": "item. Object.",
"additionalProperties": {}
},
"description": "placements. Array."
},
"limitations": {
"type": "array",
"items": {
"type": "string",
"description": "Item. String."
},
"description": "limitations. Array."
},
"loadingOrder": {
"type": "array",
"items": {
"type": "string",
"description": "Item. String."
},
"description": "loadingOrder. Array."
},
"volumeUtilisation": {
"type": "number",
"description": "volumeUtilisation. Number."
},
"weightUtilisation": {
"type": "number",
"description": "weightUtilisation. Number."
}
},
"additionalProperties": {}
},
"annotations": {
"title": "Vehicle loading order and 3D fit",
"readOnlyHint": true,
"openWorldHint": true,
"idempotentHint": true,
"destructiveHint": false
}
}Assign pre-built routes to drivers by shift, skills and vehicle type with min-cost Hungarian matching when planning routes or deliveries. Call with routes and drivers; optional skillMode, skillPenalty, allowMultiple. Returns assignments, unassigned, and totalCost (assignments includes route, driver). HTTP 200 with status complete, partial, or failed is charged at the full listed price. HTTP 4xx/5xx are not charged. Keywords: when planning routes or deliveries, routes, drivers, skillMode, skillPenalty, allowMultiple, assignments, unassigned, totalCost, Assign routes to drivers, driver shift assign.
| Parameter | Type | Description |
|---|---|---|
| routes * | array | routes, array. Required. |
| drivers * | array | drivers, array. Required. |
| skillMode | string | skillMode, string, one of strict, soft. Optional. |
| skillPenalty | number | skillPenalty, number, from 0 to any. Optional. |
| allowMultiple | boolean | allowMultiple, boolean. Optional. |
{
"name": "route-optimization_driver-shift-assign",
"title": "Assign routes to drivers",
"description": "Assign pre-built routes to drivers by shift, skills and vehicle type with min-cost Hungarian matching when planning routes or deliveries. Call with routes and drivers; optional skillMode, skillPenalty, allowMultiple. Returns assignments, unassigned, and totalCost (assignments includes route, driver). HTTP 200 with status complete, partial, or failed is charged at the full listed price. HTTP 4xx/5xx are not charged. Keywords: when planning routes or deliveries, routes, drivers, skillMode, skillPenalty, allowMultiple, assignments, unassigned, totalCost, Assign routes to drivers, driver shift assign.",
"inputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"routes",
"drivers"
],
"properties": {
"routes": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"start",
"end"
],
"properties": {
"id": {
"type": "string",
"maxLength": 120,
"minLength": 1,
"description": "id, string, length 1 to 120. Required."
},
"end": {
"type": "number",
"description": "start, number. Required."
},
"start": {
"type": "number",
"description": "start, number. Required."
},
"skills": {
"type": "array",
"items": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "item, string, length 1 to 64. Required."
},
"description": "skills, array. Optional."
},
"vehicleType": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "vehicleType, string, length 1 to 64. Optional."
}
},
"description": "item, object. Required."
},
"description": "routes, array. Required."
},
"drivers": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"shift"
],
"properties": {
"id": {
"type": "string",
"maxLength": 120,
"minLength": 1,
"description": "id, string, length 1 to 120. Required."
},
"cost": {
"type": "number",
"minimum": 0,
"description": "cost, number, from 0 to any. Optional."
},
"shift": {
"type": "array",
"items": [
{
"type": "number"
},
{
"type": "number"
}
],
"maxItems": 2,
"minItems": 2,
"description": "shift, array. Required.",
"additionalItems": false
},
"skills": {
"type": "array",
"items": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "item, string, length 1 to 64. Required."
},
"description": "skills, array. Optional."
},
"vehicleTypes": {
"type": "array",
"items": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "item, string, length 1 to 64. Required."
},
"description": "vehicleTypes, array. Optional."
}
},
"description": "item, object. Required."
},
"description": "drivers, array. Required."
},
"skillMode": {
"enum": [
"strict",
"soft"
],
"type": "string",
"description": "skillMode, string, one of strict, soft. Optional."
},
"skillPenalty": {
"type": "number",
"minimum": 0,
"description": "skillPenalty, number, from 0 to any. Optional."
},
"allowMultiple": {
"type": "boolean",
"description": "allowMultiple, boolean. Optional."
}
}
},
"outputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"sources": {
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "url. String."
},
"source": {
"type": "string",
"description": "source. String."
},
"status": {
"type": "string",
"description": "status. String."
},
"retrievedAt": {
"type": "string",
"description": "retrievedAt. String."
}
},
"description": "item. Object.",
"additionalProperties": {}
},
"description": "sources. Array."
},
"totalCost": {
"type": "number",
"description": "totalCost. Number."
},
"unassigned": {
"type": "array",
"items": {
"type": "string",
"description": "Item. String."
},
"description": "unassigned. Array."
},
"assignments": {
"type": "array",
"items": {
"type": "object",
"properties": {
"route": {
"type": "string",
"description": "route. String."
},
"driver": {
"type": "string",
"description": "driver. String."
}
},
"description": "item. Object.",
"additionalProperties": {}
},
"description": "assignments. Array."
},
"limitations": {
"type": "array",
"items": {
"type": "string",
"description": "Item. String."
},
"description": "limitations. Array."
}
},
"additionalProperties": {}
},
"annotations": {
"title": "Assign routes to drivers",
"readOnlyHint": true,
"openWorldHint": true,
"idempotentHint": true,
"destructiveHint": false
}
}Estimate bookable orders per zone and time slot from vehicle time, service, drive and stem assumptions when planning routes or deliveries. Call with zones and slots; optional booked, bufferPct, stemEverySlot. Returns slots (slots includes zone, slot, capacityOrders, booked, available). Carrying a payment-signature is not yet a charge. Settlement happens only on HTTP 2xx. HTTP 200 with status complete, partial, or failed is charged at the full listed price. HTTP 4xx/5xx are not charged. Keywords: when planning routes or deliveries, zones, slots, booked, bufferPct, stemEverySlot, Delivery slot capacity, Route & Delivery Optimisation.
| Parameter | Type | Description |
|---|---|---|
| slots * | array | slots, array. Required. |
| zones * | array | zones, array. Required. |
| booked | array | booked, array. Optional. |
| bufferPct | number | bufferPct, number, from 0 to 0.9. Optional. |
| stemEverySlot | boolean | stemEverySlot, boolean. Optional. |
{
"name": "route-optimization_delivery-slot-capacity",
"title": "Delivery slot capacity",
"description": "Estimate bookable orders per zone and time slot from vehicle time, service, drive and stem assumptions when planning routes or deliveries. Call with zones and slots; optional booked, bufferPct, stemEverySlot. Returns slots (slots includes zone, slot, capacityOrders, booked, available). Carrying a payment-signature is not yet a charge. Settlement happens only on HTTP 2xx. HTTP 200 with status complete, partial, or failed is charged at the full listed price. HTTP 4xx/5xx are not charged. Keywords: when planning routes or deliveries, zones, slots, booked, bufferPct, stemEverySlot, Delivery slot capacity, Route & Delivery Optimisation.",
"inputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"zones",
"slots"
],
"properties": {
"slots": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"start",
"end"
],
"properties": {
"id": {
"type": "string",
"maxLength": 120,
"minLength": 1,
"description": "id, string, length 1 to 120. Required."
},
"end": {
"type": "string",
"pattern": "^\\d{2}:\\d{2}$",
"description": "end, string. Required."
},
"start": {
"type": "string",
"pattern": "^\\d{2}:\\d{2}$",
"description": "start, string. Required."
}
},
"description": "item, object. Required."
},
"description": "slots, array. Required."
},
"zones": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"vehicles",
"avgServiceMin",
"avgDriveBetweenStopsMin"
],
"properties": {
"id": {
"type": "string",
"maxLength": 120,
"minLength": 1,
"description": "id, string, length 1 to 120. Required."
},
"stemMin": {
"type": "number",
"minimum": 0,
"description": "stemMin, number, from 0 to any. Optional."
},
"vehicles": {
"type": "integer",
"maximum": 10000,
"minimum": 1,
"description": "vehicles, integer, from 1 to 10000. Required."
},
"avgServiceMin": {
"type": "number",
"minimum": 0,
"description": "avgServiceMin, number, from 0 to any. Required."
},
"avgDriveBetweenStopsMin": {
"type": "number",
"minimum": 0,
"description": "avgServiceMin, number, from 0 to any. Required."
}
},
"description": "item, object. Required."
},
"description": "zones, array. Required."
},
"booked": {
"type": "array",
"items": {
"type": "object",
"required": [
"zone",
"slot",
"orders"
],
"properties": {
"slot": {
"type": "string",
"maxLength": 120,
"minLength": 1,
"description": "id, string, length 1 to 120. Required."
},
"zone": {
"type": "string",
"maxLength": 120,
"minLength": 1,
"description": "id, string, length 1 to 120. Required."
},
"orders": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0,
"description": "orders, integer, from 0 to 9007199254740991. Required."
}
},
"description": "item, object. Required."
},
"description": "booked, array. Optional."
},
"bufferPct": {
"type": "number",
"maximum": 0.9,
"minimum": 0,
"description": "bufferPct, number, from 0 to 0.9. Optional."
},
"stemEverySlot": {
"type": "boolean",
"description": "stemEverySlot, boolean. Optional."
}
}
},
"outputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"slots": {
"type": "array",
"items": {
"type": "object",
"properties": {
"slot": {
"type": "string",
"description": "slot. String."
},
"zone": {
"type": "string",
"description": "zone. String."
},
"booked": {
"type": "number",
"description": "booked. Number."
},
"available": {
"type": "number",
"description": "available. Number."
},
"capacityOrders": {
"type": "number",
"description": "capacityOrders. Number."
}
},
"description": "item. Object.",
"additionalProperties": {}
},
"description": "slots. Array."
},
"sources": {
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "url. String."
},
"source": {
"type": "string",
"description": "source. String."
},
"status": {
"type": "string",
"description": "status. String."
},
"retrievedAt": {
"type": "string",
"description": "retrievedAt. String."
}
},
"description": "item. Object.",
"additionalProperties": {}
},
"description": "sources. Array."
},
"limitations": {
"type": "array",
"items": {
"type": "string",
"description": "Item. String."
},
"description": "limitations. Array."
}
},
"additionalProperties": {}
},
"annotations": {
"title": "Delivery slot capacity",
"readOnlyHint": true,
"openWorldHint": true,
"idempotentHint": true,
"destructiveHint": false
}
}Test points against GeoJSON service zones with holes, reporting inside/in-hole status and nearest boundary distance when planning routes or deliveries. Call with zones and points. Returns results (results includes point, inside, nearestBoundaryM, inHoleOf, nearestZone). Carrying a payment-signature is not yet a charge. Settlement happens only on HTTP 2xx. HTTP 200 with status complete, partial, or failed is charged at the full listed price. HTTP 4xx/5xx are not charged. Keywords: when planning routes or deliveries, zones, points, results, Geofence point-in-polygon check, geofence check, Route & Delivery Optimisation, route optimization.
| Parameter | Type | Description |
|---|---|---|
| zones * | object | zones, object. Required. |
| points * | array | points, array. Required. |
{
"name": "route-optimization_geofence-check",
"title": "Geofence point-in-polygon check",
"description": "Test points against GeoJSON service zones with holes, reporting inside/in-hole status and nearest boundary distance when planning routes or deliveries. Call with zones and points. Returns results (results includes point, inside, nearestBoundaryM, inHoleOf, nearestZone). Carrying a payment-signature is not yet a charge. Settlement happens only on HTTP 2xx. HTTP 200 with status complete, partial, or failed is charged at the full listed price. HTTP 4xx/5xx are not charged. Keywords: when planning routes or deliveries, zones, points, results, Geofence point-in-polygon check, geofence check, Route & Delivery Optimisation, route optimization.",
"inputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"zones",
"points"
],
"properties": {
"zones": {
"type": "object",
"required": [
"type",
"features"
],
"properties": {
"type": {
"type": "string",
"const": "FeatureCollection",
"description": "type, string. Required."
},
"features": {
"type": "array",
"items": {
"type": "object",
"required": [
"type",
"geometry"
],
"properties": {
"type": {
"type": "string",
"const": "Feature",
"description": "type, string. Required."
},
"geometry": {
"type": "object",
"required": [
"type",
"coordinates"
],
"properties": {
"type": {
"enum": [
"Polygon",
"MultiPolygon"
],
"type": "string",
"description": "type, string, one of Polygon, MultiPolygon. Required."
},
"coordinates": {
"type": "array",
"items": {
"description": "item, value. Required."
},
"description": "coordinates, array. Required."
}
},
"description": "geometry, object. Required."
},
"properties": {
"type": "object",
"description": "properties, object. Optional.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
}
},
"description": "item, object. Required."
},
"description": "features, array. Required."
}
},
"description": "zones, object. Required."
},
"points": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"lon",
"lat"
],
"properties": {
"id": {
"type": "string",
"maxLength": 120,
"minLength": 1,
"description": "id, string, length 1 to 120. Required."
},
"lat": {
"type": "number",
"maximum": 90,
"minimum": -90,
"description": "lat, number, from -90 to 90. Required."
},
"lon": {
"type": "number",
"maximum": 180,
"minimum": -180,
"description": "lon, number, from -180 to 180. Required."
}
},
"description": "item, object. Required."
},
"description": "points, array. Required."
}
}
},
"outputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"results": {
"type": "array",
"items": {
"type": "object",
"properties": {
"point": {
"type": "string",
"description": "point. String."
},
"inside": {
"type": "array",
"items": {
"type": "string",
"description": "Item. String."
},
"description": "inside. Array."
},
"nearestBoundaryM": {
"type": "number",
"description": "nearestBoundaryM. Number."
}
},
"description": "item. Object.",
"additionalProperties": {}
},
"description": "results. Array."
},
"sources": {
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "url. String."
},
"source": {
"type": "string",
"description": "source. String."
},
"status": {
"type": "string",
"description": "status. String."
},
"retrievedAt": {
"type": "string",
"description": "retrievedAt. String."
}
},
"description": "item. Object.",
"additionalProperties": {}
},
"description": "sources. Array."
},
"limitations": {
"type": "array",
"items": {
"type": "string",
"description": "Item. String."
},
"description": "limitations. Array."
}
},
"additionalProperties": {}
},
"annotations": {
"title": "Geofence point-in-polygon check",
"readOnlyHint": true,
"openWorldHint": true,
"idempotentHint": true,
"destructiveHint": false
}
}Encode or decode Google Encoded Polyline strings and optionally simplify with Douglas-Peucker when planning routes or deliveries. Call with optional encode, decode, precision, simplify. Returns encoded and points. Carrying a payment-signature is not yet a charge. Settlement happens only on HTTP 2xx. Invalid JSON or schema returns HTTP 400 and is not charged. HTTP 200 with status complete, partial, or failed is charged at the full listed price. HTTP 4xx/5xx are not charged. Keywords: when planning routes or deliveries, encode, decode, precision, simplify, encoded, points, Encoded polyline encode/decode, polyline codec.
| Parameter | Type | Description |
|---|---|---|
| decode | any | decode, value. Optional. |
| encode | array | encode, array. Optional. |
| simplify | any | simplify, value. Optional. |
| precision | any | precision, value. Optional. |
{
"name": "route-optimization_polyline-codec",
"title": "Encoded polyline encode/decode",
"description": "Encode or decode Google Encoded Polyline strings and optionally simplify with Douglas-Peucker when planning routes or deliveries. Call with optional encode, decode, precision, simplify. Returns encoded and points. Carrying a payment-signature is not yet a charge. Settlement happens only on HTTP 2xx. Invalid JSON or schema returns HTTP 400 and is not charged. HTTP 200 with status complete, partial, or failed is charged at the full listed price. HTTP 4xx/5xx are not charged. Keywords: when planning routes or deliveries, encode, decode, precision, simplify, encoded, points, Encoded polyline encode/decode, polyline codec.",
"inputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"decode": {
"anyOf": [
{
"type": "string",
"maxLength": 1000000
},
{
"type": "null"
}
],
"description": "decode, value. Optional."
},
"encode": {
"type": "array",
"items": {
"type": "array",
"items": [
{
"type": "number"
},
{
"type": "number"
}
],
"maxItems": 2,
"minItems": 2,
"description": "item, array. Required.",
"additionalItems": false
},
"description": "encode, array. Optional."
},
"simplify": {
"anyOf": [
{
"type": "object",
"properties": {
"tolerance": {
"type": "number",
"description": "tolerance, number. Optional.",
"exclusiveMinimum": 0
},
"toleranceM": {
"type": "number",
"description": "toleranceM, number. Optional.",
"exclusiveMinimum": 0
}
}
},
{
"type": "null"
}
],
"description": "simplify, value. Optional."
},
"precision": {
"anyOf": [
{
"type": "number",
"const": 5
},
{
"type": "number",
"const": 6
}
],
"description": "precision, value. Optional."
}
}
},
"outputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"points": {
"type": "number",
"description": "points. Number."
},
"encoded": {
"type": "string",
"description": "encoded. String."
},
"sources": {
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "url. String."
},
"source": {
"type": "string",
"description": "source. String."
},
"status": {
"type": "string",
"description": "status. String."
},
"retrievedAt": {
"type": "string",
"description": "retrievedAt. String."
}
},
"description": "item. Object.",
"additionalProperties": {}
},
"description": "sources. Array."
},
"limitations": {
"type": "array",
"items": {
"type": "string",
"description": "Item. String."
},
"description": "limitations. Array."
}
},
"additionalProperties": {}
},
"annotations": {
"title": "Encoded polyline encode/decode",
"readOnlyHint": true,
"openWorldHint": true,
"idempotentHint": true,
"destructiveHint": false
}
}Check a manual plan for time-window, capacity, shift, precedence and duplicate/missing-stop violations when planning routes or deliveries. Call with stops, vehicles, and plan; optional depot, requests, matrix, matrixFromPoints, speed, requireAllStops. Returns valid, violations, missing, and duplicates (violations includes vehicle, stopIndex, stop, type, detail). HTTP 200 with status complete, partial, or failed is charged at the full listed price. HTTP 4xx/5xx are not charged. Keywords: when planning routes or deliveries, stops, vehicles, plan, depot, requests, matrix, matrixFromPoints, speed, requireAllStops, valid, violations, missing, duplicates, Validate a multi-vehicle route plan.
| Parameter | Type | Description |
|---|---|---|
| plan * | array | plan, array. Required. |
| depot | object | depot, object. Optional. |
| speed | number | speed, number. Optional. |
| stops * | array | stops, array. Required. |
| matrix | object | matrix, object. Optional. |
| requests | array | requests, array. Optional. |
| vehicles * | array | vehicles, array. Required. |
| requireAllStops | boolean |
Tool calls wrap the existing POST APIs and stay pay-per-call. initialize and tools/list are free. An unpaid tool call returns the x402 payment terms in the tool result and does not run. Retry with the payment in params._meta["x402/payment"], or send payment-signature. Payment settles only after a successful result.
Names, descriptions and schemas were written by the server and are shown as data.
Pattern matches on what the server declares. They show what it says it can do, not what it does.
None yet. Changes appear after a server's second daily check.
| objective, string, one of distance, duration. Optional. |
| timeLimitMs | integer | timeLimitMs, integer, from 1 to 25000. Optional. |
| matrixFromPoints | string | matrixFromPoints, string, one of euclidean, haversine. Optional. |
{
"name": "route-optimization_tsp-optimize",
"title": "Travelling salesman route order",
"description": "Find a best visiting order for one vehicle (closed tour or open path) with fixed start and optional fixed end using Held-Karp or local search when planning routes or deliveries. Call with locations and start; optional matrix, matrixFromPoints, circuity, speedMps, speed, end and others. Returns sequence, totalDistance, totalDuration, method, optimal, estimate, and timeLimitMs. HTTP 200 with status complete, partial, or failed is charged at the full listed price. HTTP 4xx/5xx are not charged. Keywords: when planning routes or deliveries, locations, start, matrix, matrixFromPoints, circuity, speedMps, speed, end, objective, timeLimitMs, sequence, totalDistance, totalDuration, method.",
"inputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"locations",
"start"
],
"properties": {
"end": {
"anyOf": [
{
"type": "string",
"maxLength": 120,
"minLength": 1
},
{
"type": "null"
}
],
"description": "end, value. Optional."
},
"speed": {
"type": "number",
"description": "speed, number. Optional.",
"exclusiveMinimum": 0
},
"start": {
"type": "string",
"maxLength": 120,
"minLength": 1,
"description": "id, string, length 1 to 120. Required."
},
"matrix": {
"type": "object",
"required": [
"distances"
],
"properties": {
"distances": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "number",
"description": "item, number. Required."
},
"description": "item, array. Required."
},
"description": "distances, array. Required."
},
"durations": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "number",
"description": "item, number. Required."
},
"description": "item, array. Required."
},
"description": "durations, array. Optional."
}
},
"description": "matrix, object. Optional."
},
"circuity": {
"type": "number",
"maximum": 3,
"minimum": 1,
"description": "circuity, number, from 1 to 3. Optional."
},
"speedMps": {
"type": "number",
"description": "speedMps, number. Optional.",
"exclusiveMinimum": 0
},
"locations": {
"type": "array",
"items": {
"type": "object",
"required": [
"id"
],
"properties": {
"x": {
"type": "number",
"description": "x, number. Optional."
},
"y": {
"type": "number",
"description": "y, number. Optional."
},
"id": {
"type": "string",
"maxLength": 120,
"minLength": 1,
"description": "id, string, length 1 to 120. Required."
},
"lat": {
"type": "number",
"maximum": 90,
"minimum": -90,
"description": "lat, number, from -90 to 90. Optional."
},
"lon": {
"type": "number",
"maximum": 180,
"minimum": -180,
"description": "lon, number, from -180 to 180. Optional."
}
},
"description": "item, object. Required."
},
"description": "locations, array. Required."
},
"objective": {
"enum": [
"distance",
"duration"
],
"type": "string",
"description": "objective, string, one of distance, duration. Optional."
},
"timeLimitMs": {
"type": "integer",
"maximum": 25000,
"minimum": 1,
"description": "timeLimitMs, integer, from 1 to 25000. Optional."
},
"matrixFromPoints": {
"enum": [
"euclidean",
"haversine"
],
"type": "string",
"description": "matrixFromPoints, string, one of euclidean, haversine. Optional."
}
}
},
"outputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"method": {
"type": "string",
"description": "method. String."
},
"optimal": {
"type": "boolean",
"description": "optimal. Boolean."
},
"sources": {
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "url. String."
},
"source": {
"type": "string",
"description": "source. String."
},
"status": {
"type": "string",
"description": "status. String."
},
"retrievedAt": {
"type": "string",
"description": "retrievedAt. String."
}
},
"description": "item. Object.",
"additionalProperties": {}
},
"description": "sources. Array."
},
"estimate": {
"type": "boolean",
"description": "estimate. Boolean."
},
"sequence": {
"type": "array",
"items": {
"type": "string",
"description": "Item. String."
},
"description": "sequence. Array."
},
"limitations": {
"type": "array",
"items": {
"type": "string",
"description": "Item. String."
},
"description": "limitations. Array."
},
"timeLimitMs": {
"type": "number",
"description": "timeLimitMs. Number."
},
"totalDistance": {
"type": "number",
"description": "totalDistance. Number."
},
"totalDuration": {
"type": "number",
"description": "totalDuration. Number."
}
},
"additionalProperties": {}
},
"annotations": {
"title": "Travelling salesman route order",
"readOnlyHint": true,
"openWorldHint": true,
"idempotentHint": true,
"destructiveHint": false
}
}| vehicles, array. Required. |
| timeLimitMs | integer | timeLimitMs, integer, from 1 to 25000. Optional. |
| matrixFromPoints | string | matrixFromPoints, string, one of euclidean, haversine. Optional. |
| maxRouteDuration | any | maxRouteDuration, value. Optional. |
{
"name": "route-optimization_vrp-capacitated",
"title": "Capacitated vehicle routing",
"description": "Assign stops to vehicles under capacity (and optional duration) limits, returning routes with loads and distances when planning routes or deliveries. Call with depot, stops, and vehicles; optional matrix, matrixFromPoints, circuity, speedMps, speed, maxRouteDuration and others. Returns routes, totalDistance, unassigned, method, optimal, estimate. HTTP 200 with status complete, partial, or failed is charged at the full listed price. HTTP 4xx/5xx are not charged. Keywords: when planning routes or deliveries, depot, stops, vehicles, matrix, matrixFromPoints, circuity, speedMps, speed, maxRouteDuration, minimise, timeLimitMs, routes, totalDistance, unassigned.",
"inputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"depot",
"stops",
"vehicles"
],
"properties": {
"depot": {
"type": "object",
"required": [
"id"
],
"properties": {
"x": {
"type": "number",
"description": "x, number. Optional."
},
"y": {
"type": "number",
"description": "y, number. Optional."
},
"id": {
"type": "string",
"maxLength": 120,
"minLength": 1,
"description": "id, string, length 1 to 120. Required."
},
"lat": {
"type": "number",
"maximum": 90,
"minimum": -90,
"description": "lat, number, from -90 to 90. Optional."
},
"lon": {
"type": "number",
"maximum": 180,
"minimum": -180,
"description": "lon, number, from -180 to 180. Optional."
}
},
"description": "depot, object. Required."
},
"speed": {
"type": "number",
"description": "speed, number. Optional.",
"exclusiveMinimum": 0
},
"stops": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"demand"
],
"properties": {
"x": {
"type": "number",
"description": "x, number. Optional."
},
"y": {
"type": "number",
"description": "y, number. Optional."
},
"id": {
"type": "string",
"maxLength": 120,
"minLength": 1,
"description": "id, string, length 1 to 120. Required."
},
"lat": {
"type": "number",
"maximum": 90,
"minimum": -90,
"description": "lat, number, from -90 to 90. Optional."
},
"lon": {
"type": "number",
"maximum": 180,
"minimum": -180,
"description": "lon, number, from -180 to 180. Optional."
},
"demand": {
"anyOf": [
{
"type": "number",
"minimum": 0
},
{
"type": "array",
"items": {
"type": "number",
"minimum": 0
},
"maxItems": 8,
"minItems": 1
}
],
"description": "demand, value. Required."
}
},
"description": "item, object. Required."
},
"description": "stops, array. Required."
},
"matrix": {
"type": "object",
"required": [
"distances"
],
"properties": {
"distances": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "number",
"description": "item, number. Required."
},
"description": "item, array. Required."
},
"description": "distances, array. Required."
},
"durations": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "number",
"description": "item, number. Required."
},
"description": "item, array. Required."
},
"description": "durations, array. Optional."
}
},
"description": "matrix, object. Optional."
},
"circuity": {
"type": "number",
"maximum": 3,
"minimum": 1,
"description": "circuity, number, from 1 to 3. Optional."
},
"minimise": {
"enum": [
"distance",
"duration"
],
"type": "string",
"description": "minimise, string, one of distance, duration. Optional."
},
"speedMps": {
"type": "number",
"description": "speedMps, number. Optional.",
"exclusiveMinimum": 0
},
"vehicles": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"capacity"
],
"properties": {
"id": {
"type": "string",
"maxLength": 120,
"minLength": 1,
"description": "id, string, length 1 to 120. Required."
},
"end": {
"type": "object",
"required": [
"id"
],
"properties": {
"x": {
"type": "number",
"description": "x, number. Optional."
},
"y": {
"type": "number",
"description": "y, number. Optional."
},
"id": {
"type": "string",
"maxLength": 120,
"minLength": 1,
"description": "id, string, length 1 to 120. Required."
},
"lat": {
"type": "number",
"maximum": 90,
"minimum": -90,
"description": "lat, number, from -90 to 90. Optional."
},
"lon": {
"type": "number",
"maximum": 180,
"minimum": -180,
"description": "lon, number, from -180 to 180. Optional."
}
},
"description": "end, object. Optional."
},
"start": {
"type": "object",
"required": [
"id"
],
"properties": {
"x": {
"type": "number",
"description": "x, number. Optional."
},
"y": {
"type": "number",
"description": "y, number. Optional."
},
"id": {
"type": "string",
"maxLength": 120,
"minLength": 1,
"description": "id, string, length 1 to 120. Required."
},
"lat": {
"type": "number",
"maximum": 90,
"minimum": -90,
"description": "lat, number, from -90 to 90. Optional."
},
"lon": {
"type": "number",
"maximum": 180,
"minimum": -180,
"description": "lon, number, from -180 to 180. Optional."
}
},
"description": "start, object. Optional."
},
"capacity": {
"anyOf": [
{
"type": "number",
"minimum": 0
},
{
"type": "array",
"items": {
"type": "number",
"minimum": 0
},
"maxItems": 8,
"minItems": 1
}
],
"description": "demand, value. Required."
}
},
"description": "item, object. Required."
},
"description": "vehicles, array. Required."
},
"timeLimitMs": {
"type": "integer",
"maximum": 25000,
"minimum": 1,
"description": "timeLimitMs, integer, from 1 to 25000. Optional."
},
"matrixFromPoints": {
"enum": [
"euclidean",
"haversine"
],
"type": "string",
"description": "matrixFromPoints, string, one of euclidean, haversine. Optional."
},
"maxRouteDuration": {
"anyOf": [
{
"type": "number",
"minimum": 0
},
{
"type": "null"
}
],
"description": "maxRouteDuration, value. Optional."
}
}
},
"outputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"method": {
"type": "string",
"description": "method. String."
},
"routes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"load": {
"type": "number",
"description": "load. Number."
},
"stops": {
"type": "array",
"items": {
"type": "string",
"description": "Item. String."
},
"description": "stops. Array."
},
"vehicle": {
"type": "string",
"description": "vehicle. String."
},
"distance": {
"type": "number",
"description": "distance. Number."
},
"duration": {
"type": "number",
"description": "duration. Number."
}
},
"description": "item. Object.",
"additionalProperties": {}
},
"description": "routes. Array."
},
"optimal": {
"type": "boolean",
"description": "optimal. Boolean."
},
"sources": {
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "url. String."
},
"source": {
"type": "string",
"description": "source. String."
},
"status": {
"type": "string",
"description": "status. String."
},
"retrievedAt": {
"type": "string",
"description": "retrievedAt. String."
}
},
"description": "item. Object.",
"additionalProperties": {}
},
"description": "sources. Array."
},
"estimate": {
"type": "boolean",
"description": "estimate. Boolean."
},
"unassigned": {
"type": "array",
"items": {
"type": "string",
"description": "Item. String."
},
"description": "unassigned. Array."
},
"limitations": {
"type": "array",
"items": {
"type": "string",
"description": "Item. String."
},
"description": "limitations. Array."
},
"timeLimitMs": {
"type": "number",
"description": "timeLimitMs. Number."
},
"totalDistance": {
"type": "number",
"description": "totalDistance. Number."
}
},
"additionalProperties": {}
},
"annotations": {
"title": "Capacitated vehicle routing",
"readOnlyHint": true,
"openWorldHint": true,
"idempotentHint": true,
"destructiveHint": false
}
}| vehicles, array. Required. |
| timeLimitMs | integer | timeLimitMs, integer, from 1 to 25000. Optional. |
| matrixFromPoints | string | matrixFromPoints, string, one of euclidean, haversine. Optional. |
{
"name": "route-optimization_vrp-time-windows",
"title": "Vehicle routing with time windows",
"description": "Route stops under customer time windows, service times, driver shifts and breaks with forward time propagation when planning routes or deliveries. Call with depot, stops, and vehicles; optional matrix, matrixFromPoints, circuity, speed, speedMps, minimise and others. Returns routes, unassigned, method, optimal, estimate, and timeLimitMs. HTTP 200 with status complete, partial, or failed is charged at the full listed price. HTTP 4xx/5xx are not charged. Keywords: when planning routes or deliveries, depot, stops, vehicles, matrix, matrixFromPoints, circuity, speed, speedMps, minimise, timeLimitMs, routes, unassigned, method, optimal.",
"inputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"depot",
"stops",
"vehicles"
],
"properties": {
"depot": {
"type": "object",
"required": [
"id"
],
"properties": {
"x": {
"type": "number",
"description": "x, number. Optional."
},
"y": {
"type": "number",
"description": "y, number. Optional."
},
"id": {
"type": "string",
"maxLength": 120,
"minLength": 1,
"description": "id, string, length 1 to 120. Required."
},
"lat": {
"type": "number",
"maximum": 90,
"minimum": -90,
"description": "lat, number, from -90 to 90. Optional."
},
"lon": {
"type": "number",
"maximum": 180,
"minimum": -180,
"description": "lon, number, from -180 to 180. Optional."
},
"window": {
"type": "array",
"items": [
{
"type": "number"
},
{
"type": "number"
}
],
"maxItems": 2,
"minItems": 2,
"description": "window, array. Optional.",
"additionalItems": false
}
},
"description": "depot, object. Required."
},
"speed": {
"type": "number",
"description": "speed, number. Optional.",
"exclusiveMinimum": 0
},
"stops": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"window"
],
"properties": {
"x": {
"type": "number",
"description": "x, number. Optional."
},
"y": {
"type": "number",
"description": "y, number. Optional."
},
"id": {
"type": "string",
"maxLength": 120,
"minLength": 1,
"description": "id, string, length 1 to 120. Required."
},
"lat": {
"type": "number",
"maximum": 90,
"minimum": -90,
"description": "lat, number, from -90 to 90. Optional."
},
"lon": {
"type": "number",
"maximum": 180,
"minimum": -180,
"description": "lon, number, from -180 to 180. Optional."
},
"demand": {
"anyOf": [
{
"type": "number",
"minimum": 0
},
{
"type": "array",
"items": {
"type": "number",
"minimum": 0
},
"maxItems": 8,
"minItems": 1
}
],
"description": "demand, value. Optional."
},
"window": {
"type": "array",
"items": [
{
"type": "number"
},
{
"type": "number"
}
],
"maxItems": 2,
"minItems": 2,
"description": "window, array. Required.",
"additionalItems": false
},
"service": {
"type": "number",
"minimum": 0,
"description": "service, number, from 0 to any. Optional."
}
},
"description": "item, object. Required."
},
"description": "stops, array. Required."
},
"matrix": {
"type": "object",
"required": [
"distances"
],
"properties": {
"distances": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "number",
"description": "item, number. Required."
},
"description": "item, array. Required."
},
"description": "distances, array. Required."
},
"durations": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "number",
"description": "item, number. Required."
},
"description": "item, array. Required."
},
"description": "durations, array. Optional."
}
},
"description": "matrix, object. Optional."
},
"circuity": {
"type": "number",
"maximum": 3,
"minimum": 1,
"description": "circuity, number, from 1 to 3. Optional."
},
"minimise": {
"enum": [
"distance",
"completion_time",
"vehicles"
],
"type": "string",
"description": "minimise, string, one of distance, completion_time, vehicles. Optional."
},
"speedMps": {
"type": "number",
"description": "speedMps, number. Optional.",
"exclusiveMinimum": 0
},
"vehicles": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"shift"
],
"properties": {
"id": {
"type": "string",
"maxLength": 120,
"minLength": 1,
"description": "id, string, length 1 to 120. Required."
},
"shift": {
"type": "array",
"items": [
{
"type": "number"
},
{
"type": "number"
}
],
"maxItems": 2,
"minItems": 2,
"description": "window, array. Required.",
"additionalItems": false
},
"breaks": {
"type": "array",
"items": {
"type": "object",
"required": [
"window",
"duration"
],
"properties": {
"window": {
"type": "array",
"items": [
{
"type": "number"
},
{
"type": "number"
}
],
"maxItems": 2,
"minItems": 2,
"description": "window, array. Required.",
"additionalItems": false
},
"duration": {
"type": "number",
"minimum": 0,
"description": "duration, number, from 0 to any. Required."
}
},
"description": "item, object. Required."
},
"description": "breaks, array. Optional."
},
"capacity": {
"anyOf": [
{
"type": "number",
"minimum": 0
},
{
"type": "array",
"items": {
"type": "number",
"minimum": 0
},
"maxItems": 8,
"minItems": 1
}
],
"description": "capacity, value. Optional."
}
},
"description": "item, object. Required."
},
"description": "vehicles, array. Required."
},
"timeLimitMs": {
"type": "integer",
"maximum": 25000,
"minimum": 1,
"description": "timeLimitMs, integer, from 1 to 25000. Optional."
},
"matrixFromPoints": {
"enum": [
"euclidean",
"haversine"
],
"type": "string",
"description": "matrixFromPoints, string, one of euclidean, haversine. Optional."
}
}
},
"outputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"method": {
"type": "string",
"description": "method. String."
},
"routes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"end": {
"type": "number",
"description": "end. Number."
},
"stops": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id. String."
},
"wait": {
"type": "number",
"description": "wait. Number."
},
"start": {
"type": "number",
"description": "start. Number."
},
"arrival": {
"type": "number",
"description": "arrival. Number."
},
"departure": {
"type": "number",
"description": "departure. Number."
}
},
"description": "item. Object.",
"additionalProperties": {}
},
"description": "stops. Array."
},
"vehicle": {
"type": "string",
"description": "vehicle. String."
},
"distance": {
"type": "number",
"description": "distance. Number."
},
"totalWait": {
"type": "number",
"description": "totalWait. Number."
}
},
"description": "item. Object.",
"additionalProperties": {}
},
"description": "routes. Array."
},
"optimal": {
"type": "boolean",
"description": "optimal. Boolean."
},
"sources": {
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "url. String."
},
"source": {
"type": "string",
"description": "source. String."
},
"status": {
"type": "string",
"description": "status. String."
},
"retrievedAt": {
"type": "string",
"description": "retrievedAt. String."
}
},
"description": "item. Object.",
"additionalProperties": {}
},
"description": "sources. Array."
},
"estimate": {
"type": "boolean",
"description": "estimate. Boolean."
},
"unassigned": {
"type": "array",
"items": {
"type": "string",
"description": "Item. String."
},
"description": "unassigned. Array."
},
"limitations": {
"type": "array",
"items": {
"type": "string",
"description": "Item. String."
},
"description": "limitations. Array."
},
"timeLimitMs": {
"type": "number",
"description": "timeLimitMs. Number."
}
},
"additionalProperties": {}
},
"annotations": {
"title": "Vehicle routing with time windows",
"readOnlyHint": true,
"openWorldHint": true,
"idempotentHint": true,
"destructiveHint": false
}
}| string |
| matrixFromPoints, string, one of euclidean, haversine. Optional. |
{
"name": "route-optimization_pickup-delivery",
"title": "Pickup and delivery routing",
"description": "Route paired pickup-and-delivery requests with precedence, same-vehicle and capacity constraints when planning routes or deliveries. Call with depot, requests, and vehicles; optional matrix, matrixFromPoints, circuity, speed, timeLimitMs. Returns routes, unassigned, method, optimal, and estimate (routes includes vehicle, sequence, distance, maxLoad). HTTP 200 with status complete, partial, or failed is charged at the full listed price. HTTP 4xx/5xx are not charged. Keywords: when planning routes or deliveries, depot, requests, vehicles, matrix, matrixFromPoints, circuity, speed, timeLimitMs, routes, unassigned, method, optimal, estimate, Pickup and delivery routing.",
"inputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"depot",
"requests",
"vehicles"
],
"properties": {
"depot": {
"type": "object",
"required": [
"id"
],
"properties": {
"x": {
"type": "number",
"description": "x, number. Optional."
},
"y": {
"type": "number",
"description": "y, number. Optional."
},
"id": {
"type": "string",
"maxLength": 120,
"minLength": 1,
"description": "id, string, length 1 to 120. Required."
},
"lat": {
"type": "number",
"maximum": 90,
"minimum": -90,
"description": "lat, number, from -90 to 90. Optional."
},
"lon": {
"type": "number",
"maximum": 180,
"minimum": -180,
"description": "lon, number, from -180 to 180. Optional."
}
},
"description": "depot, object. Required."
},
"speed": {
"type": "number",
"description": "speed, number. Optional.",
"exclusiveMinimum": 0
},
"matrix": {
"type": "object",
"required": [
"distances"
],
"properties": {
"distances": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "number",
"description": "item, number. Required."
},
"description": "item, array. Required."
},
"description": "distances, array. Required."
},
"durations": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "number",
"description": "item, number. Required."
},
"description": "item, array. Required."
},
"description": "durations, array. Optional."
}
},
"description": "matrix, object. Optional."
},
"circuity": {
"type": "number",
"maximum": 3,
"minimum": 1,
"description": "circuity, number, from 1 to 3. Optional."
},
"requests": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"pickup",
"delivery",
"quantity"
],
"properties": {
"id": {
"type": "string",
"maxLength": 120,
"minLength": 1,
"description": "id, string, length 1 to 120. Required."
},
"pickup": {
"type": "object",
"required": [
"id"
],
"properties": {
"x": {
"type": "number",
"description": "x, number. Optional."
},
"y": {
"type": "number",
"description": "y, number. Optional."
},
"id": {
"type": "string",
"maxLength": 120,
"minLength": 1,
"description": "id, string, length 1 to 120. Required."
},
"lat": {
"type": "number",
"maximum": 90,
"minimum": -90,
"description": "lat, number, from -90 to 90. Optional."
},
"lon": {
"type": "number",
"maximum": 180,
"minimum": -180,
"description": "lon, number, from -180 to 180. Optional."
}
},
"description": "pickup, object. Required."
},
"delivery": {
"type": "object",
"required": [
"id"
],
"properties": {
"x": {
"type": "number",
"description": "x, number. Optional."
},
"y": {
"type": "number",
"description": "y, number. Optional."
},
"id": {
"type": "string",
"maxLength": 120,
"minLength": 1,
"description": "id, string, length 1 to 120. Required."
},
"lat": {
"type": "number",
"maximum": 90,
"minimum": -90,
"description": "lat, number, from -90 to 90. Optional."
},
"lon": {
"type": "number",
"maximum": 180,
"minimum": -180,
"description": "lon, number, from -180 to 180. Optional."
}
},
"description": "delivery, object. Required."
},
"quantity": {
"type": "number",
"minimum": 0,
"description": "quantity, number, from 0 to any. Required."
}
},
"description": "item, object. Required."
},
"description": "requests, array. Required."
},
"vehicles": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"capacity"
],
"properties": {
"id": {
"type": "string",
"maxLength": 120,
"minLength": 1,
"description": "id, string, length 1 to 120. Required."
},
"capacity": {
"type": "number",
"minimum": 0,
"description": "quantity, number, from 0 to any. Required."
}
},
"description": "item, object. Required."
},
"description": "vehicles, array. Required."
},
"timeLimitMs": {
"type": "integer",
"maximum": 25000,
"minimum": 1,
"description": "timeLimitMs, integer, from 1 to 25000. Optional."
},
"matrixFromPoints": {
"enum": [
"euclidean",
"haversine"
],
"type": "string",
"description": "matrixFromPoints, string, one of euclidean, haversine. Optional."
}
}
},
"outputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"method": {
"type": "string",
"description": "method. String."
},
"routes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"maxLoad": {
"type": "number",
"description": "maxLoad. Number."
},
"vehicle": {
"type": "string",
"description": "vehicle. String."
},
"distance": {
"type": "number",
"description": "distance. Number."
},
"sequence": {
"type": "array",
"items": {
"type": "string",
"description": "Item. String."
},
"description": "sequence. Array."
}
},
"description": "item. Object.",
"additionalProperties": {}
},
"description": "routes. Array."
},
"optimal": {
"type": "boolean",
"description": "optimal. Boolean."
},
"sources": {
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "url. String."
},
"source": {
"type": "string",
"description": "source. String."
},
"status": {
"type": "string",
"description": "status. String."
},
"retrievedAt": {
"type": "string",
"description": "retrievedAt. String."
}
},
"description": "item. Object.",
"additionalProperties": {}
},
"description": "sources. Array."
},
"estimate": {
"type": "boolean",
"description": "estimate. Boolean."
},
"unassigned": {
"type": "array",
"items": {
"type": "string",
"description": "Item. String."
},
"description": "unassigned. Array."
},
"limitations": {
"type": "array",
"items": {
"type": "string",
"description": "Item. String."
},
"description": "limitations. Array."
}
},
"additionalProperties": {}
},
"annotations": {
"title": "Pickup and delivery routing",
"readOnlyHint": true,
"openWorldHint": true,
"idempotentHint": true,
"destructiveHint": false
}
}| string |
| matrixFromPoints, string, one of euclidean, haversine. Optional. |
{
"name": "route-optimization_multi-day-plan",
"title": "Multi-day visit planning",
"description": "Assign recurring visits across a horizon with frequency and spacing rules, then route each day when planning routes or deliveries. Call with horizonDays, stops, and depot; optional vehiclesPerDay, capacityPerDay, matrix, matrixFromPoints, timeLimitMs. Returns days, visitPatterns, and unassigned (days includes day, route, distance). HTTP 200 with status complete, partial, or failed is charged at the full listed price. HTTP 4xx/5xx are not charged. Keywords: when planning routes or deliveries, horizonDays, stops, depot, vehiclesPerDay, capacityPerDay, matrix, matrixFromPoints, timeLimitMs, days, visitPatterns, unassigned, Multi-day visit planning, multi day plan.",
"inputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"horizonDays",
"stops",
"depot"
],
"properties": {
"depot": {
"type": "object",
"properties": {
"x": {
"type": "number",
"description": "x, number. Optional."
},
"y": {
"type": "number",
"description": "y, number. Optional."
},
"id": {
"type": "string",
"maxLength": 120,
"minLength": 1,
"description": "id, string, length 1 to 120. Optional."
},
"lat": {
"type": "number",
"maximum": 90,
"minimum": -90,
"description": "lat, number, from -90 to 90. Optional."
},
"lon": {
"type": "number",
"maximum": 180,
"minimum": -180,
"description": "lon, number, from -180 to 180. Optional."
}
},
"description": "depot, object. Required."
},
"stops": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"visitsPerWeek"
],
"properties": {
"x": {
"type": "number",
"description": "x, number. Optional."
},
"y": {
"type": "number",
"description": "y, number. Optional."
},
"id": {
"type": "string",
"maxLength": 120,
"minLength": 1,
"description": "item, string, length 1 to 120. Required."
},
"lat": {
"type": "number",
"maximum": 90,
"minimum": -90,
"description": "lat, number, from -90 to 90. Optional."
},
"lon": {
"type": "number",
"maximum": 180,
"minimum": -180,
"description": "lon, number, from -180 to 180. Optional."
},
"demand": {
"type": "number",
"minimum": 0,
"description": "demand, number, from 0 to any. Optional."
},
"minGapDays": {
"type": "integer",
"maximum": 28,
"minimum": 0,
"description": "minGapDays, integer, from 0 to 28. Optional."
},
"allowedDays": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string",
"maxLength": 120,
"minLength": 1,
"description": "item, string, length 1 to 120. Required."
}
},
{
"type": "null"
}
],
"description": "allowedDays, value. Optional."
},
"visitsPerWeek": {
"type": "integer",
"maximum": 28,
"minimum": 1,
"description": "visitsPerWeek, integer, from 1 to 28. Required."
}
},
"description": "item, object. Required."
},
"description": "stops, array. Required."
},
"matrix": {
"type": "object",
"required": [
"distances"
],
"properties": {
"distances": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "number",
"description": "item, number. Required."
},
"description": "item, array. Required."
},
"description": "distances, array. Required."
},
"durations": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "number",
"description": "item, number. Required."
},
"description": "item, array. Required."
},
"description": "durations, array. Optional."
}
},
"description": "matrix, object. Optional."
},
"horizonDays": {
"type": "array",
"items": {
"type": "string",
"maxLength": 120,
"minLength": 1,
"description": "item, string, length 1 to 120. Required."
},
"description": "horizonDays, array. Required."
},
"timeLimitMs": {
"type": "integer",
"maximum": 25000,
"minimum": 1,
"description": "timeLimitMs, integer, from 1 to 25000. Optional."
},
"capacityPerDay": {
"anyOf": [
{
"type": "number",
"minimum": 0
},
{
"type": "null"
}
],
"description": "capacityPerDay, value. Optional."
},
"vehiclesPerDay": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "vehiclesPerDay, integer, from 1 to 100. Optional."
},
"matrixFromPoints": {
"enum": [
"euclidean",
"haversine"
],
"type": "string",
"description": "matrixFromPoints, string, one of euclidean, haversine. Optional."
}
}
},
"outputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"days": {
"type": "array",
"items": {
"type": "object",
"properties": {
"day": {
"type": "string",
"description": "day. String."
},
"route": {
"type": "array",
"items": {
"type": "string",
"description": "Item. String."
},
"description": "route. Array."
},
"distance": {
"type": "number",
"description": "distance. Number."
}
},
"description": "item. Object.",
"additionalProperties": {}
},
"description": "days. Array."
},
"sources": {
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "url. String."
},
"source": {
"type": "string",
"description": "source. String."
},
"status": {
"type": "string",
"description": "status. String."
},
"retrievedAt": {
"type": "string",
"description": "retrievedAt. String."
}
},
"description": "item. Object.",
"additionalProperties": {}
},
"description": "sources. Array."
},
"unassigned": {
"type": "array",
"items": {
"type": "string",
"description": "Item. String."
},
"description": "unassigned. Array."
},
"limitations": {
"type": "array",
"items": {
"type": "string",
"description": "Item. String."
},
"description": "limitations. Array."
},
"visitPatterns": {
"type": "array",
"items": {
"type": "object",
"properties": {
"days": {
"type": "array",
"items": {
"type": "string",
"description": "Item. String."
},
"description": "days. Array."
},
"stop": {
"type": "string",
"description": "stop. String."
}
},
"description": "item. Object.",
"additionalProperties": {}
},
"description": "visitPatterns. Array."
}
},
"additionalProperties": {}
},
"annotations": {
"title": "Multi-day visit planning",
"readOnlyHint": true,
"openWorldHint": true,
"idempotentHint": true,
"destructiveHint": false
}
}{
"name": "route-optimization_territory-cluster",
"title": "Balanced territory clustering",
"description": "Split stops into k balanced, compact territories with capacitated k-means and imbalance limits when planning routes or deliveries. Call with stops and k; optional balanceBy, maxImbalance, matrixFromPoints, seed. Returns territories, imbalance, and withinSse (territories includes id, stops, size, centroid). HTTP 200 with status complete, partial, or failed is charged at the full listed price. HTTP 4xx/5xx are not charged. Keywords: when planning routes or deliveries, stops, balanceBy, maxImbalance, matrixFromPoints, seed, territories, imbalance, withinSse, Balanced territory clustering, territory cluster.",
"inputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"stops",
"k"
],
"properties": {
"k": {
"type": "integer",
"maximum": 500,
"minimum": 1,
"description": "k, integer, from 1 to 500. Required."
},
"seed": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"description": "seed, integer, from -9007199254740991 to 9007199254740991. Optional."
},
"stops": {
"type": "array",
"items": {
"type": "object",
"required": [
"id"
],
"properties": {
"x": {
"type": "number",
"description": "x, number. Optional."
},
"y": {
"type": "number",
"description": "y, number. Optional."
},
"id": {
"type": "string",
"maxLength": 120,
"minLength": 1,
"description": "id, string, length 1 to 120. Required."
},
"lat": {
"type": "number",
"maximum": 90,
"minimum": -90,
"description": "lat, number, from -90 to 90. Optional."
},
"lon": {
"type": "number",
"maximum": 180,
"minimum": -180,
"description": "lon, number, from -180 to 180. Optional."
},
"weight": {
"type": "number",
"minimum": 0,
"description": "weight, number, from 0 to any. Optional."
}
},
"description": "item, object. Required."
},
"description": "stops, array. Required."
},
"balanceBy": {
"enum": [
"count",
"weight"
],
"type": "string",
"description": "balanceBy, string, one of count, weight. Optional."
},
"maxImbalance": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "maxImbalance, number, from 0 to 1. Optional."
},
"matrixFromPoints": {
"enum": [
"euclidean",
"haversine"
],
"type": "string",
"description": "matrixFromPoints, string, one of euclidean, haversine. Optional."
}
}
},
"outputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"sources": {
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "url. String."
},
"source": {
"type": "string",
"description": "source. String."
},
"status": {
"type": "string",
"description": "status. String."
},
"retrievedAt": {
"type": "string",
"description": "retrievedAt. String."
}
},
"description": "item. Object.",
"additionalProperties": {}
},
"description": "sources. Array."
},
"imbalance": {
"type": "number",
"description": "imbalance. Number."
},
"withinSse": {
"type": "number",
"description": "withinSse. Number."
},
"limitations": {
"type": "array",
"items": {
"type": "string",
"description": "Item. String."
},
"description": "limitations. Array."
},
"territories": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number",
"description": "id. Number."
},
"size": {
"type": "number",
"description": "size. Number."
},
"stops": {
"type": "array",
"items": {
"type": "string",
"description": "Item. String."
},
"description": "stops. Array."
},
"centroid": {
"type": "array",
"items": {
"type": "number",
"description": "item. Number."
},
"description": "centroid. Array."
}
},
"description": "item. Object.",
"additionalProperties": {}
},
"description": "territories. Array."
}
},
"additionalProperties": {}
},
"annotations": {
"title": "Balanced territory clustering",
"readOnlyHint": true,
"openWorldHint": true,
"idempotentHint": true,
"destructiveHint": false
}
}{
"name": "route-optimization_depot-location-optimize",
"title": "Depot / hub location (p-median)",
"description": "Choose p hub locations from candidates to minimise demand-weighted distance, optionally capacitated when planning routes or deliveries. Call with demand, candidates, and p; optional matrix, matrixFromPoints, capacities. Returns selected, objective, allocation, method, and optimal (allocation includes demand, facility). HTTP 200 with status complete, partial, or failed is charged at the full listed price. HTTP 4xx/5xx are not charged. Keywords: when planning routes or deliveries, demand, candidates, matrix, matrixFromPoints, capacities, selected, objective, allocation, method, optimal, Depot / hub location (p-median), depot location optimize.",
"inputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"demand",
"candidates",
"p"
],
"properties": {
"p": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "p, integer, from 1 to 100. Required."
},
"demand": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"weight"
],
"properties": {
"x": {
"type": "number",
"description": "x, number. Optional."
},
"y": {
"type": "number",
"description": "y, number. Optional."
},
"id": {
"type": "string",
"maxLength": 120,
"minLength": 1,
"description": "id, string, length 1 to 120. Required."
},
"lat": {
"type": "number",
"maximum": 90,
"minimum": -90,
"description": "lat, number, from -90 to 90. Optional."
},
"lon": {
"type": "number",
"maximum": 180,
"minimum": -180,
"description": "lon, number, from -180 to 180. Optional."
},
"weight": {
"type": "number",
"minimum": 0,
"description": "weight, number, from 0 to any. Required."
}
},
"description": "item, object. Required."
},
"description": "demand, array. Required."
},
"matrix": {
"type": "object",
"required": [
"distances"
],
"properties": {
"distances": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "number",
"description": "item, number. Required."
},
"description": "item, array. Required."
},
"description": "distances, array. Required."
},
"durations": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "number",
"description": "item, number. Required."
},
"description": "item, array. Required."
},
"description": "durations, array. Optional."
}
},
"description": "matrix, object. Optional."
},
"candidates": {
"type": "array",
"items": {
"type": "object",
"required": [
"id"
],
"properties": {
"x": {
"type": "number",
"description": "x, number. Optional."
},
"y": {
"type": "number",
"description": "y, number. Optional."
},
"id": {
"type": "string",
"maxLength": 120,
"minLength": 1,
"description": "id, string, length 1 to 120. Required."
},
"lat": {
"type": "number",
"maximum": 90,
"minimum": -90,
"description": "lat, number, from -90 to 90. Optional."
},
"lon": {
"type": "number",
"maximum": 180,
"minimum": -180,
"description": "lon, number, from -180 to 180. Optional."
}
},
"description": "item, object. Required."
},
"description": "candidates, array. Required."
},
"capacities": {
"anyOf": [
{
"type": "array",
"items": {
"type": "number",
"minimum": 0
}
},
{
"type": "null"
}
],
"description": "capacities, value. Optional."
},
"matrixFromPoints": {
"enum": [
"euclidean",
"haversine"
],
"type": "string",
"description": "matrixFromPoints, string, one of euclidean, haversine. Optional."
}
}
},
"outputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"method": {
"type": "string",
"description": "method. String."
},
"optimal": {
"type": "boolean",
"description": "optimal. Boolean."
},
"sources": {
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "url. String."
},
"source": {
"type": "string",
"description": "source. String."
},
"status": {
"type": "string",
"description": "status. String."
},
"retrievedAt": {
"type": "string",
"description": "retrievedAt. String."
}
},
"description": "item. Object.",
"additionalProperties": {}
},
"description": "sources. Array."
},
"selected": {
"type": "array",
"items": {
"type": "string",
"description": "Item. String."
},
"description": "selected. Array."
},
"objective": {
"type": "number",
"description": "objective. Number."
},
"allocation": {
"type": "array",
"items": {
"type": "object",
"properties": {
"demand": {
"type": "string",
"description": "demand. String."
},
"facility": {
"type": "string",
"description": "facility. String."
}
},
"description": "item. Object.",
"additionalProperties": {}
},
"description": "allocation. Array."
},
"limitations": {
"type": "array",
"items": {
"type": "string",
"description": "Item. String."
},
"description": "limitations. Array."
}
},
"additionalProperties": {}
},
"annotations": {
"title": "Depot / hub location (p-median)",
"readOnlyHint": true,
"openWorldHint": true,
"idempotentHint": true,
"destructiveHint": false
}
}{
"name": "route-optimization_route-eta-schedule",
"title": "ETA schedule for a fixed sequence",
"description": "Compute arrivals, waits, slack and overtime for a fixed stop sequence with optional return and shift end when planning routes or deliveries. Call with start and sequence; optional returnTo, matrix, matrixFromPoints, speed, speedMps, shiftEnd. Returns stops, returnTime, overtime, violations, totalDistance, and estimate. HTTP 200 with status complete, partial, or failed is charged at the full listed price. HTTP 4xx/5xx are not charged. Keywords: when planning routes or deliveries, start, sequence, returnTo, matrix, matrixFromPoints, speed, speedMps, shiftEnd, stops, returnTime, overtime, violations, totalDistance, estimate.",
"inputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"start",
"sequence"
],
"properties": {
"speed": {
"type": "number",
"description": "speed, number. Optional.",
"exclusiveMinimum": 0
},
"start": {
"type": "object",
"required": [
"id"
],
"properties": {
"x": {
"type": "number",
"description": "x, number. Optional."
},
"y": {
"type": "number",
"description": "y, number. Optional."
},
"id": {
"type": "string",
"maxLength": 120,
"minLength": 1,
"description": "id, string, length 1 to 120. Required."
},
"lat": {
"type": "number",
"maximum": 90,
"minimum": -90,
"description": "lat, number, from -90 to 90. Optional."
},
"lon": {
"type": "number",
"maximum": 180,
"minimum": -180,
"description": "lon, number, from -180 to 180. Optional."
},
"time": {
"type": "number",
"description": "time, number. Optional."
}
},
"description": "start, object. Required."
},
"matrix": {
"type": "object",
"required": [
"distances"
],
"properties": {
"distances": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "number",
"description": "item, number. Required."
},
"description": "item, array. Required."
},
"description": "distances, array. Required."
},
"durations": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "number",
"description": "item, number. Required."
},
"description": "item, array. Required."
},
"description": "durations, array. Optional."
}
},
"description": "matrix, object. Optional."
},
"returnTo": {
"type": "object",
"properties": {
"x": {
"type": "number",
"description": "x, number. Optional."
},
"y": {
"type": "number",
"description": "y, number. Optional."
},
"id": {
"type": "string",
"maxLength": 120,
"minLength": 1,
"description": "id, string, length 1 to 120. Optional."
},
"lat": {
"type": "number",
"maximum": 90,
"minimum": -90,
"description": "lat, number, from -90 to 90. Optional."
},
"lon": {
"type": "number",
"maximum": 180,
"minimum": -180,
"description": "lon, number, from -180 to 180. Optional."
}
},
"description": "returnTo, object. Optional."
},
"sequence": {
"type": "array",
"items": {
"type": "object",
"required": [
"id"
],
"properties": {
"x": {
"type": "number",
"description": "x, number. Optional."
},
"y": {
"type": "number",
"description": "y, number. Optional."
},
"id": {
"type": "string",
"maxLength": 120,
"minLength": 1,
"description": "id, string, length 1 to 120. Required."
},
"lat": {
"type": "number",
"maximum": 90,
"minimum": -90,
"description": "lat, number, from -90 to 90. Optional."
},
"lon": {
"type": "number",
"maximum": 180,
"minimum": -180,
"description": "lon, number, from -180 to 180. Optional."
},
"window": {
"type": "array",
"items": [
{
"type": "number"
},
{
"type": "number"
}
],
"maxItems": 2,
"minItems": 2,
"description": "window, array. Optional.",
"additionalItems": false
},
"service": {
"type": "number",
"minimum": 0,
"description": "service, number, from 0 to any. Optional."
}
},
"description": "item, object. Required."
},
"description": "sequence, array. Required."
},
"shiftEnd": {
"type": "number",
"description": "shiftEnd, number. Optional."
},
"speedMps": {
"type": "number",
"description": "speedMps, number. Optional.",
"exclusiveMinimum": 0
},
"matrixFromPoints": {
"enum": [
"euclidean",
"haversine"
],
"type": "string",
"description": "matrixFromPoints, string, one of euclidean, haversine. Optional."
}
}
},
"outputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"stops": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id. String."
},
"late": {
"type": "boolean",
"description": "late. Boolean."
},
"wait": {
"type": "number",
"description": "wait. Number."
},
"slack": {
"type": "number",
"description": "slack. Number."
},
"start": {
"type": "number",
"description": "start. Number."
},
"lateBy": {
"type": "number",
"description": "lateBy. Number."
},
"arrival": {
"type": "number",
"description": "arrival. Number."
},
"departure": {
"type": "number",
"description": "departure. Number."
}
},
"description": "item. Object.",
"additionalProperties": {}
},
"description": "stops. Array."
},
"sources": {
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "url. String."
},
"source": {
"type": "string",
"description": "source. String."
},
"status": {
"type": "string",
"description": "status. String."
},
"retrievedAt": {
"type": "string",
"description": "retrievedAt. String."
}
},
"description": "item. Object.",
"additionalProperties": {}
},
"description": "sources. Array."
},
"estimate": {
"type": "boolean",
"description": "estimate. Boolean."
},
"overtime": {
"type": "number",
"description": "overtime. Number."
},
"returnTime": {
"type": "number",
"description": "returnTime. Number."
},
"violations": {
"type": "array",
"items": {
"type": "string",
"description": "Item. String."
},
"description": "violations. Array."
},
"limitations": {
"type": "array",
"items": {
"type": "string",
"description": "Item. String."
},
"description": "limitations. Array."
},
"totalDistance": {
"type": "number",
"description": "totalDistance. Number."
}
},
"additionalProperties": {}
},
"annotations": {
"title": "ETA schedule for a fixed sequence",
"readOnlyHint": true,
"openWorldHint": true,
"idempotentHint": true,
"destructiveHint": false
}
}| requireAllStops, boolean. Optional. |
| matrixFromPoints | string | matrixFromPoints, string, one of euclidean, haversine. Optional. |
{
"name": "route-optimization_route-plan-validate",
"title": "Validate a multi-vehicle route plan",
"description": "Check a manual plan for time-window, capacity, shift, precedence and duplicate/missing-stop violations when planning routes or deliveries. Call with stops, vehicles, and plan; optional depot, requests, matrix, matrixFromPoints, speed, requireAllStops. Returns valid, violations, missing, and duplicates (violations includes vehicle, stopIndex, stop, type, detail). HTTP 200 with status complete, partial, or failed is charged at the full listed price. HTTP 4xx/5xx are not charged. Keywords: when planning routes or deliveries, stops, vehicles, plan, depot, requests, matrix, matrixFromPoints, speed, requireAllStops, valid, violations, missing, duplicates, Validate a multi-vehicle route plan.",
"inputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"stops",
"vehicles",
"plan"
],
"properties": {
"plan": {
"type": "array",
"items": {
"type": "object",
"required": [
"vehicle",
"sequence"
],
"properties": {
"vehicle": {
"type": "string",
"maxLength": 120,
"minLength": 1,
"description": "id, string, length 1 to 120. Required."
},
"sequence": {
"type": "array",
"items": {
"type": "string",
"maxLength": 120,
"minLength": 1,
"description": "id, string, length 1 to 120. Required."
},
"description": "sequence, array. Required."
}
},
"description": "item, object. Required."
},
"description": "plan, array. Required."
},
"depot": {
"type": "object",
"required": [
"id"
],
"properties": {
"x": {
"type": "number",
"description": "x, number. Optional."
},
"y": {
"type": "number",
"description": "y, number. Optional."
},
"id": {
"type": "string",
"maxLength": 120,
"minLength": 1,
"description": "id, string, length 1 to 120. Required."
},
"lat": {
"type": "number",
"maximum": 90,
"minimum": -90,
"description": "lat, number, from -90 to 90. Optional."
},
"lon": {
"type": "number",
"maximum": 180,
"minimum": -180,
"description": "lon, number, from -180 to 180. Optional."
},
"window": {
"type": "array",
"items": [
{
"type": "number"
},
{
"type": "number"
}
],
"maxItems": 2,
"minItems": 2,
"description": "window, array. Optional.",
"additionalItems": false
}
},
"description": "depot, object. Optional."
},
"speed": {
"type": "number",
"description": "speed, number. Optional.",
"exclusiveMinimum": 0
},
"stops": {
"type": "array",
"items": {
"type": "object",
"required": [
"id"
],
"properties": {
"x": {
"type": "number",
"description": "x, number. Optional."
},
"y": {
"type": "number",
"description": "y, number. Optional."
},
"id": {
"type": "string",
"maxLength": 120,
"minLength": 1,
"description": "id, string, length 1 to 120. Required."
},
"lat": {
"type": "number",
"maximum": 90,
"minimum": -90,
"description": "lat, number, from -90 to 90. Optional."
},
"lon": {
"type": "number",
"maximum": 180,
"minimum": -180,
"description": "lon, number, from -180 to 180. Optional."
},
"demand": {
"anyOf": [
{
"type": "number",
"minimum": 0
},
{
"type": "array",
"items": {
"type": "number",
"minimum": 0
},
"maxItems": 8,
"minItems": 1
}
],
"description": "demand, value. Optional."
},
"window": {
"type": "array",
"items": [
{
"type": "number"
},
{
"type": "number"
}
],
"maxItems": 2,
"minItems": 2,
"description": "window, array. Optional.",
"additionalItems": false
},
"service": {
"type": "number",
"minimum": 0,
"description": "service, number, from 0 to any. Optional."
}
},
"description": "item, object. Required."
},
"description": "stops, array. Required."
},
"matrix": {
"type": "object",
"required": [
"distances"
],
"properties": {
"distances": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "number",
"description": "item, number. Required."
},
"description": "item, array. Required."
},
"description": "distances, array. Required."
},
"durations": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "number",
"description": "item, number. Required."
},
"description": "item, array. Required."
},
"description": "durations, array. Optional."
}
},
"description": "matrix, object. Optional."
},
"requests": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"pickup",
"delivery",
"quantity"
],
"properties": {
"id": {
"type": "string",
"maxLength": 120,
"minLength": 1,
"description": "id, string, length 1 to 120. Required."
},
"pickup": {
"type": "string",
"maxLength": 120,
"minLength": 1,
"description": "id, string, length 1 to 120. Required."
},
"delivery": {
"type": "string",
"maxLength": 120,
"minLength": 1,
"description": "id, string, length 1 to 120. Required."
},
"quantity": {
"type": "number",
"minimum": 0,
"description": "duration, number, from 0 to any. Required."
}
},
"description": "item, object. Required."
},
"description": "requests, array. Optional."
},
"vehicles": {
"type": "array",
"items": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"maxLength": 120,
"minLength": 1,
"description": "id, string, length 1 to 120. Required."
},
"shift": {
"type": "array",
"items": [
{
"type": "number"
},
{
"type": "number"
}
],
"maxItems": 2,
"minItems": 2,
"description": "shift, array. Optional.",
"additionalItems": false
},
"breaks": {
"type": "array",
"items": {
"type": "object",
"required": [
"window",
"duration"
],
"properties": {
"window": {
"type": "array",
"items": [
{
"type": "number"
},
{
"type": "number"
}
],
"maxItems": 2,
"minItems": 2,
"description": "window, array. Required.",
"additionalItems": false
},
"duration": {
"type": "number",
"minimum": 0,
"description": "duration, number, from 0 to any. Required."
}
},
"description": "item, object. Required."
},
"description": "breaks, array. Optional."
},
"capacity": {
"anyOf": [
{
"type": "number",
"minimum": 0
},
{
"type": "array",
"items": {
"type": "number",
"minimum": 0
},
"maxItems": 8,
"minItems": 1
}
],
"description": "capacity, value. Optional."
}
},
"description": "item, object. Required."
},
"description": "vehicles, array. Required."
},
"requireAllStops": {
"type": "boolean",
"description": "requireAllStops, boolean. Optional."
},
"matrixFromPoints": {
"enum": [
"euclidean",
"haversine"
],
"type": "string",
"description": "matrixFromPoints, string, one of euclidean, haversine. Optional."
}
}
},
"outputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"valid": {
"type": "boolean",
"description": "valid. Boolean."
},
"missing": {
"type": "array",
"items": {
"type": "string",
"description": "Item. String."
},
"description": "missing. Array."
},
"sources": {
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "url. String."
},
"source": {
"type": "string",
"description": "source. String."
},
"status": {
"type": "string",
"description": "status. String."
},
"retrievedAt": {
"type": "string",
"description": "retrievedAt. String."
}
},
"description": "item. Object.",
"additionalProperties": {}
},
"description": "sources. Array."
},
"duplicates": {
"type": "array",
"items": {
"type": "string",
"description": "Item. String."
},
"description": "duplicates. Array."
},
"violations": {
"type": "array",
"items": {
"type": "object",
"properties": {
"stop": {
"type": "string",
"description": "stop. String."
},
"type": {
"type": "string",
"description": "type. String."
},
"detail": {
"type": "string",
"description": "detail. String."
},
"vehicle": {
"type": "string",
"description": "vehicle. String."
},
"stopIndex": {
"type": "number",
"description": "stopIndex. Number."
}
},
"description": "item. Object.",
"additionalProperties": {}
},
"description": "violations. Array."
},
"limitations": {
"type": "array",
"items": {
"type": "string",
"description": "Item. String."
},
"description": "limitations. Array."
}
},
"additionalProperties": {}
},
"annotations": {
"title": "Validate a multi-vehicle route plan",
"readOnlyHint": true,
"openWorldHint": true,
"idempotentHint": true,
"destructiveHint": false
}
}