Skip to main content
POST
Submit route optimization

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

corridor
integer
default:8000

Search corridor width in meters around the route for finding charging stations.

Required range: 1000 <= x <= 20000
min_charge_duration_min
integer
default:0

Minimum charging session duration in minutes enforced by the optimizer's charge planning (pure charging time, excluding connecting/parking overhead). 0 disables the floor.

Required range: 0 <= x <= 100
tenant_id
integer | null

Tenant ID

Body

application/json

Top-level request body for POST /planner and POST /planner/v2.

vehicle_id
string
required

The unique identifier of the vehicle.

battery_level_start
number
required

The starting battery level of the vehicle (from 0.1 to 1.0).

Required range: 0.1 <= x <= 1
section_list
SectionRequest · object[]
required

A list of route sections to be processed.

Minimum array length: 1
poi_info
POIInfo · object
required

Filter criteria for charging stations along the route.

battery_level_end
number | null
default:0.2

The desired battery level at the end of the tour (from 0.1 to 0.8).

Required range: 0.1 <= x <= 0.8
service_time_departure_min
number | null
default:0

Service time at departure in minutes. Added to total tour duration.

start_time_tour
string | null

Start time of the tour in HH:MM:SS or ISO-8601 format. A time-only value is interpreted as today's date in UTC.

include_available_charging_stations
boolean
default:false

Legacy POST /planner (v1) only: when true, the synchronous response includes all charging stations along the corridor. POST /planner/v2 results always include available_charging_stations.

Response

Successful Response

Response body for POST /planner/v2.

message
string
required

Human-readable status message.

tour_id
integer
required

Tour identifier.

optimization_id
integer | null

Optimization identifier. Use this to retrieve the result via GET /planner/optimizations/{optimization_id}/result.

job_id
string | null

Job identifier (UUID). Use this to poll for status via GET /planner/jobs/{job_id}.

warnings
string[] | null

Warnings about the request, if any.