Getting Started
Example Routes
Vehicles
Charging Stations
Submit route optimization
Submit a route for optimization. The request is processed asynchronously and returns HTTP 202 with identifiers to track the job.
Use the returned job_id to poll GET /planner/jobs/{job_id} for status. Once status is succeeded, retrieve the result via GET /planner/optimizations/{optimization_id}/result.
curl --request POST \
--url https://staging.api.fryte.xyz/planner/v2 \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"battery_level_end": 0.2,
"battery_level_start": 0.8,
"poi_info": {
"connector_pos": "RIGHT",
"connector_type": [
"CCS"
],
"min_kW": 150,
"truck_approved": "T"
},
"section_list": [
{
"payload_kg": 19300,
"section_id": "section_0",
"service_time_min": 30,
"start_pos": [
48.7758,
9.1829
],
"stop_pos": [
49.4521,
11.0767
]
}
],
"start_time_tour": "08:00:00",
"vehicle_id": "010160700001"
}
'{
"job_id": "c3f1c944-a44c-4c07-ab52-7df7ba94024a",
"message": "202 - Job submitted.",
"optimization_id": 7658,
"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.
Query Parameters
Search corridor width in meters around the route for finding charging stations.
1000 <= x <= 20000Tenant ID
Body
Top-level request body schema for the planner.
The starting battery level of the vehicle (from 0.1 to 1.0).
0.1 <= x <= 1A list of route sections to be processed.
Show child attributes
Show child attributes
Filter criteria for charging stations along the route.
Show child attributes
Show child attributes
The desired battery level at the end of the tour (from 0.1 to 0.8).
0.1 <= x <= 0.8Service time at departure in minutes, counted as driving time.
Start time of the tour in HH:MM:SS or ISO-8601 format.
When true, the response includes all charging stations along the corridor.
Response
Successful Response
Human-readable status message.
Internal tour identifier.
Optimization identifier. Use this to retrieve the result via GET /planner/optimizations/{optimization_id}/result.
Job identifier (UUID). Use this to poll for status via GET /planner/jobs/{job_id}.
Warnings about the request, if any.
curl --request POST \
--url https://staging.api.fryte.xyz/planner/v2 \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"battery_level_end": 0.2,
"battery_level_start": 0.8,
"poi_info": {
"connector_pos": "RIGHT",
"connector_type": [
"CCS"
],
"min_kW": 150,
"truck_approved": "T"
},
"section_list": [
{
"payload_kg": 19300,
"section_id": "section_0",
"service_time_min": 30,
"start_pos": [
48.7758,
9.1829
],
"stop_pos": [
49.4521,
11.0767
]
}
],
"start_time_tour": "08:00:00",
"vehicle_id": "010160700001"
}
'{
"job_id": "c3f1c944-a44c-4c07-ab52-7df7ba94024a",
"message": "202 - Job submitted.",
"optimization_id": 7658,
"tour_id": 7615
}