Skip to content
Plaza Plaza Docs
GuidesPlaygroundDashboard
API Reference

Optimize

Optimize route through waypoints
optimize.create(OptimizeCreateParams**kwargs) -> OptimizeResult
POST/api/v1/optimize
Get async optimization result
optimize.retrieve(strjob_id) -> OptimizeJobStatus
GET/api/v1/optimize/{job_id}
ModelsExpand Collapse
class OptimizeCompletedResult: …

Completed optimization — GeoJSON Feature with optimized route

geometry: GeoJsonGeometry
coordinates: Union[List[float], List[List[float]], List[List[List[float]]], List[List[List[List[float]]]]]

GeoJSON coordinates array (nesting depth varies by geometry type)

One of the following:
List[float]
List[List[float]]
List[List[List[float]]]
List[List[List[List[float]]]]
type: Literal["Point", "LineString", "Polygon", 3 more]
One of the following:
"Point"
"LineString"
"Polygon"
"MultiPoint"
"MultiLineString"
"MultiPolygon"
properties: Properties
distance: Optional[float]

Total distance in meters

duration: Optional[float]

Estimated duration in seconds

waypoint_order: Optional[List[int]]

Optimized waypoint ordering

status: Literal["completed"]

Job status

type: Literal["Feature"]
class OptimizeJobStatus: …

Status of an async optimization job

status: Literal["completed", "processing", "failed"]

Job status

One of the following:
"completed"
"processing"
"failed"
error: Optional[str]

Error message when failed

result: Optional[object]

Optimization result when completed

class OptimizeProcessingResult: …

Async optimization in progress — poll with the job_id

job_id: str

Job ID for polling

status: Literal["processing"]

Job status

class OptimizeRequest: …

Route optimization request through waypoints

waypoints: GeoJsonGeometry

Waypoints to visit (GeoJSON MultiPoint geometry, minimum 2 points)

coordinates: Union[List[float], List[List[float]], List[List[List[float]]], List[List[List[List[float]]]]]

GeoJSON coordinates array (nesting depth varies by geometry type)

One of the following:
List[float]
List[List[float]]
List[List[List[float]]]
List[List[List[List[float]]]]
type: Literal["Point", "LineString", "Polygon", 3 more]
One of the following:
"Point"
"LineString"
"Polygon"
"MultiPoint"
"MultiLineString"
"MultiPolygon"
mode: Optional[Literal["auto", "foot", "bicycle"]]

Travel mode (default: auto)

One of the following:
"auto"
"foot"
"bicycle"
roundtrip: Optional[bool]

Whether route returns to start (default: true)

OptimizeResult

Optimization response — either a completed GeoJSON Feature route or an async job reference

One of the following:
class OptimizeCompletedResult: …

Completed optimization — GeoJSON Feature with optimized route

geometry: GeoJsonGeometry
coordinates: Union[List[float], List[List[float]], List[List[List[float]]], List[List[List[List[float]]]]]

GeoJSON coordinates array (nesting depth varies by geometry type)

One of the following:
List[float]
List[List[float]]
List[List[List[float]]]
List[List[List[List[float]]]]
type: Literal["Point", "LineString", "Polygon", 3 more]
One of the following:
"Point"
"LineString"
"Polygon"
"MultiPoint"
"MultiLineString"
"MultiPolygon"
properties: Properties
distance: Optional[float]

Total distance in meters

duration: Optional[float]

Estimated duration in seconds

waypoint_order: Optional[List[int]]

Optimized waypoint ordering

status: Literal["completed"]

Job status

type: Literal["Feature"]
class OptimizeProcessingResult: …

Async optimization in progress — poll with the job_id

job_id: str

Job ID for polling

status: Literal["processing"]

Job status