Driver Assignment API

Introduction

The Driver Assignment API assigns best available drivers to open tasks based on specific constraints. It helps optimize the resource allocation in real-time, ensuring efficient service to ride-hailing passengers and any other service appointments.

Key Features

• Smart Order-to-Driver Matching: Assign drivers intelligently based on task requirements, vehicle specifications, and other custom business rules.
• Flexible Cost Models: Optimize driver assignments with multiple cost options - time-based, distance-based, or straight-line calculations.
• Advanced Filtering: Refine driver selection with distance and duration constraints to ensure optimal efficiency.
• Back-to-back orders: Allow drivers to efficiently complete consecutive trips without delays.

Create a Driver Assignment request

The Driver Assignment API requests the pickup and drop off locations of the orders and the details of available vehicles to fulfill the orders. A vehicle with an ongoing trip can also be configured by specifying the waypoints remaining on the current trip. Additionally, the service also supports constraints like, distance or duration based filters and custom vehicle preferences, to determine the most favoured vehicle for fulfilling each order.

Request Parameters

Request Body

Driver Assignment API Response

The Driver Assignment API response includes the details of assignments along with the sequence in which the ongoing steps and pickups can be completed. The orders which remained unassigned and the vehicles which were not assigned to any orders are also returned. The complete details of a trip along with drop off steps can be accessed by setting the dropoff_details parameter to true in the input request.

Response Body

Driver Assignment API Example

Sample Request

1
curl --location 'https://api.nextbillion.io/optimization/driver-assignment/v1?key=<your_api_key>' --header 'Content-Type: application/json; charset=utf-8' --data '{
2
    "filter": {...},
3
    "options": {...},
4
    "orders": [...],
5
    "vehicles": [...]
6
}'

Sample Response

1
{
2
   "status": 200,
3
   "result": {
4
       "trips": [....],
5
       "unassigned_orders": [....],
6
       "available_vehicles": [....],
7
   }
8
}

API Rate Limits and Usage Restrictions

1. Nextbillion.ai allows a maximum rate limit of 300 queries per minute or 5 queries/second for continuous requests.
   Note: We can increase the quota if needed on request. Contact [email protected] for more details.
2. The maximum radius that can be specified for a filter is 10000 meters..
3. The maximum pickup_eta that can be specified for a filter is 3600 seconds.
4. The maximum number of orders that can be added in a single request is 200.
5. The maximum number of vehicles that can be specified in a single request is 100.
6. The maximum number of remaining_waypoints that can be added for a vehicle is 10.
7. The maximum number of attributes that can be specified for a single vehicle is 30.
8. A maximum of 10 attribute conditions can be specified under each of required_all_of_attributes, required_any_of_attributes and exclude_all_of_attributes for an order.

API Error Handling