Getting Started
Example Routes
Vehicles
Charging Stations
Get optimization result
Retrieve the optimization result for a completed job.
Call this endpoint once GET /planner/jobs/{job_id} returns status succeeded or not_drivable.
A succeeded result contains route sections with charging stop details (poi_summary) and candidate charging stations (poi_list). If the route includes toll roads, a toll_summary is included. When status is not_drivable, the not_drivable_reason field explains why the route is not feasible.
curl --request GET \
--url https://staging.api.fryte.xyz/planner/optimizations/{optimization_id}/result \
--header 'Authorization: Bearer <token>'{
"battery_level_end": 0.41,
"battery_level_start": 0.8,
"optimization_id": 7658,
"poi_list": [],
"qualification": "Driveable",
"sections": [
{
"length_m": 215246,
"payload_kg": 19300,
"poi_summary": {
"address": "See Destination",
"charge_time_min": 0,
"coordinate_lat": 49.4521,
"coordinate_lon": 11.0767,
"energy_kWh": 0,
"name": "Destination",
"sec_duration_min": 201.95,
"sec_length_km": 215.25,
"service_time_min": 0,
"start_soc": 0.41,
"stop_soc": 0.41
},
"polyline": "BlX8w2pJ4wh4B...",
"service_time_min": 30,
"start_pos": [
48.7758,
9.1829,
0.8
],
"stop_pos": [
49.4521,
11.0767,
0.41
]
}
],
"status": "succeeded",
"toll_summary": [
{
"currency": "EUR",
"tollSystem": "TOLL COLLECT GMBH",
"total": 81.41
}
],
"tour_id": 7615
}Documentation Index
Fetch the complete documentation index at: https://docs.fryte.com/llms.txt
Use this file to discover all available pages before exploring further.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Optimization identifier returned by POST /planner/v2.
Query Parameters
Tenant ID
Response
Successful Response
Optimization identifier.
Internal tour identifier.
Job status: succeeded or not_drivable.
Starting battery level (0-1).
Battery level at the end of the tour (0-1).
Route feasibility: Driveable or not_drivable.
Route sections with charging stop details. May contain more sections than the request if charging stops were inserted.
Show child attributes
Show child attributes
Charging stations considered as candidates along the route.
Show child attributes
Show child attributes
Charging station filter criteria applied to this optimization.
Show child attributes
Show child attributes
Optimal departure time (HH:MM:SS) for reaching all time windows, if applicable.
Whether all time windows could be reached.
All charging stations found within the route corridor. Only included when include_available_charging_stations is true.
Show child attributes
Show child attributes
Reason why the route is not drivable.
Show child attributes
Show child attributes
Toll costs aggregated per toll system.
Show child attributes
Show child attributes
curl --request GET \
--url https://staging.api.fryte.xyz/planner/optimizations/{optimization_id}/result \
--header 'Authorization: Bearer <token>'{
"battery_level_end": 0.41,
"battery_level_start": 0.8,
"optimization_id": 7658,
"poi_list": [],
"qualification": "Driveable",
"sections": [
{
"length_m": 215246,
"payload_kg": 19300,
"poi_summary": {
"address": "See Destination",
"charge_time_min": 0,
"coordinate_lat": 49.4521,
"coordinate_lon": 11.0767,
"energy_kWh": 0,
"name": "Destination",
"sec_duration_min": 201.95,
"sec_length_km": 215.25,
"service_time_min": 0,
"start_soc": 0.41,
"stop_soc": 0.41
},
"polyline": "BlX8w2pJ4wh4B...",
"service_time_min": 30,
"start_pos": [
48.7758,
9.1829,
0.8
],
"stop_pos": [
49.4521,
11.0767,
0.41
]
}
],
"status": "succeeded",
"toll_summary": [
{
"currency": "EUR",
"tollSystem": "TOLL COLLECT GMBH",
"total": 81.41
}
],
"tour_id": 7615
}