API Playground

Explore the OptiRoute API interactively. Select an endpoint, customise the request, and inspect the live response.

Endpoint

Core

Jobs

Analytics

Billing

Health

POST/v1/optimize

Submit a route optimization problem

JWT

Authentication

Authorization Header

Your session cookie is sent automatically. Override the header above if testing with a different token.

Request Body

{
  "vehicles": [
    {
      "id": "v1",
      "start": {
        "lat": 51.509,
        "lng": -0.118
      },
      "end": {
        "lat": 51.509,
        "lng": -0.118
      },
      "capacity": 100,
      "shift_start": "08:00",
      "shift_end": "17:00"
    },
    {
      "id": "v2",
      "start": {
        "lat": 51.515,
        "lng": -0.142
      },
      "end": {
        "lat": 51.515,
        "lng": -0.142
      },
      "capacity": 80,
      "shift_start": "09:00",
      "shift_end": "18:00"
    }
  ],
  "tasks": [
    {
      "id": "t1",
      "location": {
        "lat": 51.521,
        "lng": -0.13
      },
      "duration": 15,
      "demand": 20
    },
    {
      "id": "t2",
      "location": {
        "lat": 51.498,
        "lng": -0.175
      },
      "duration": 20,
      "demand": 35
    },
    {
      "id": "t3",
      "location": {
        "lat": 51.507,
        "lng": -0.088
      },
      "duration": 10,
      "demand": 15
    },
    {
      "id": "t4",
      "location": {
        "lat": 51.531,
        "lng": -0.105
      },
      "duration": 25,
      "demand": 40
    }
  ],
  "constraints": {
    "max_route_duration": 480,
    "respect_time_windows": true
  },
  "objective_weights": {
    "total_distance": 0.5,
    "num_vehicles": 0.3,
    "total_duration": 0.2
  }
}

Response

Select an endpoint and send a request to see the response here.

Request History

No requests yet. Send a request to build your history.

Quick Reference

JWT endpoints use your session cookie automatically. Override with the Authorization header field above.

API Key endpoints require a key generated from the Settings page. Enter it in the authentication section.

Health endpoints need no authentication and are safe to call anytime.