Vehicles API

Complete reference for the Vehicles API endpoints, including vehicle management, status updates, and ride operations.

Vehicle States

Available vehicle states in the system

DOCKED
Vehicle is docked at a depot
EN_ROUTE_TO_PICKUP
Vehicle is heading to pickup location
AWAITING_PASSENGER
Vehicle is waiting for passenger
IN_RIDE
Vehicle is currently in a ride
RETURNING
Vehicle is returning to depot

Endpoints

Available API endpoints for vehicle management

MethodEndpointDescription
GET
/api/vehicles/List all vehicles
POST
/api/vehicles/Create a new vehicle
GET
/api/vehicles/{id}/Get vehicle details
POST
/api/vehicles/{id}/request_ride/Request a ride from vehicle
POST
/api/vehicles/{id}/complete_ride/Complete current ride
POST
/api/vehicles/{id}/schedule_maintenance/Schedule vehicle maintenance

Battery Management

Vehicles automatically monitor battery levels and request charging when below 20%.

  • Battery level monitoring
  • Automatic charging requests
  • Charging status updates
  • Low battery alerts

Maintenance

Schedule and track vehicle maintenance through the API.

  • Maintenance scheduling
  • Service history tracking
  • Maintenance alerts
  • Service status updates