Skip to content
Plaza Plaza Docs
GuidesPlaygroundDashboard
API Reference

Optimize

Optimize route through waypoints
$client->optimize->create(GeoJsonGeometry waypoints, ?Mode mode, ?bool roundtrip): OptimizeResult
POST/api/v1/optimize
Get async optimization result
$client->optimize->retrieve(string jobID): OptimizeJobStatus
GET/api/v1/optimize/{job_id}
ModelsExpand Collapse
Properties properties
Status status

Job status

Type type
Status status

Job status

?string error

Error message when failed

?mixed result

Optimization result when completed

string jobID

Job ID for polling

Status status

Job status

GeoJsonGeometry waypoints

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

?Mode mode

Travel mode (default: auto)

?bool roundtrip

Whether route returns to start (default: true)

One of the following:
Properties properties
Status status

Job status

Type type
string jobID

Job ID for polling

Status status

Job status