API Changelog

A complete history of additions, improvements, fixes, and breaking changes to the OptiRoute API.

Showing 20 of 20 entries

February 10, 2026
v2.8.0
Feature

Interactive API Playground

A new interactive playground lets you craft requests, inspect responses, and explore every endpoint directly from the developer portal. Includes request history and built-in auth handling.

Affected Endpoints

GET/docs/playground
February 6, 2026
v2.8.0
Feature

Quick Start Guide & Concepts Documentation

Added comprehensive Quick Start guide with step-by-step instructions, and a Concepts page explaining optimization models, time windows, vehicle capacities, and constraint types.

February 1, 2026
v2.8.0
Improvement

Changelog Page

You are looking at it! A searchable, filterable changelog to keep you informed of every API change.

January 20, 2026
v2.7.0
Feature

OSRM Route Geometry in Responses

Optimization results now include encoded polyline geometry for every route leg, enabling direct map rendering without a separate directions call.

Affected Endpoints

POST/v1/optimizePOST/v1/solve
January 15, 2026
v2.7.0
Improvement

ML Schema Improvements

Aligned MlModelStatus, MlPerformanceResponse, DemandForecastResponse and MlRetrainResponse schemas with actual service return values. Removed speculative fields that were never populated.

Affected Endpoints

GET/v1/portal/ml/statusPOST/v1/portal/ml/retrain
January 8, 2026
v2.6.2
Fix

Billing Summary Schema Alignment

Fixed a mismatch between the billing summary Pydantic schema and the actual database query results. The response now correctly includes usage breakdown by plan tier.

Affected Endpoints

GET/v1/billing/summary
January 5, 2026
v2.6.2
Fix

SQL ORDER BY Fix in Job Listing

Resolved an issue where job listing could return results in non-deterministic order when multiple jobs shared the same creation timestamp.

Affected Endpoints

GET/v1/jobs
December 18, 2025
v2.6.0
Feature

AI Chat Assistant with Multi-Context Support

Introduced an AI-powered chat assistant that understands your optimization context. Supports multi-turn conversations with context awareness across jobs, routes, and analytics.

Affected Endpoints

POST/v1/chatGET/v1/chat/history
December 12, 2025
v2.6.0
Feature

LLM Tools: Explain, Anomaly Detection, Natural Language Parsing

New LLM-powered endpoints can explain optimization results in plain English, detect anomalies in route patterns, and parse natural language scheduling requests into structured optimization payloads.

Affected Endpoints

POST/v1/llm/explainPOST/v1/llm/anomalyPOST/v1/llm/parse
December 3, 2025
v2.5.1
Fix

Analytics Routes Response Schema Fix

Fixed AnalyticsRoutesResponse, AnalyticsCarbonFootprint, AnalyticsEfficiencyTrends, and AnalyticsRecommendation schemas to match actual service output. Removed ghost fields that returned null.

Affected Endpoints

GET/v1/analytics/routes
November 20, 2025
v2.5.0
Feature

Webhook System with Delivery Tracking

Register webhook URLs to receive real-time notifications for job completion, failures, and status changes. Includes delivery logs, automatic retries with exponential back-off, and signature verification.

Affected Endpoints

POST/v1/webhooksGET/v1/webhooksDELETE/v1/webhooks/{id}
November 10, 2025
v2.5.0
Feature

Report Scheduling

Schedule recurring PDF and CSV reports for fleet analytics, cost breakdowns, and SLA compliance. Reports are generated asynchronously and delivered via webhook or email.

Affected Endpoints

POST/v1/reports/scheduleGET/v1/reports
November 2, 2025
v2.4.0
Feature

GDPR Compliance: Data Export & Account Deletion

New endpoints for GDPR compliance allow users to export all personal data as a downloadable archive and request permanent account deletion with a 30-day grace period.

Affected Endpoints

POST/v1/gdpr/exportPOST/v1/gdpr/delete
October 22, 2025
v2.3.0
Feature

Re-Optimization Endpoint for Incremental Updates

Submit partial changes (new tasks, removed vehicles, shifted time windows) to an existing solution and receive an updated plan without re-solving from scratch.

Affected Endpoints

POST/v1/reoptimize
Breaking Change — action required before migration deadline
October 8, 2025
v2.2.1
Breaking

Authentication Scopes Restructured

API key scopes have been restructured for finer-grained access control. Existing keys with the legacy 'all' scope will continue to work until January 2026, after which they must be replaced.

Migration Guide

Generate new API keys with explicit scopes (optimize:write, jobs:read, analytics:read, etc.) via the portal Settings page. Legacy keys with scope 'all' will be rejected after 2026-01-31.

Affected Endpoints

POST/v1/auth/keysGET/v1/auth/keys
September 25, 2025
v2.2.0
Feature

Distance Matrix API with Multi-Profile Support

Compute travel time and distance matrices for car, truck, and bicycle profiles. Supports up to 100x100 origins/destinations per request using OSRM.

Affected Endpoints

POST/v1/matrix
September 10, 2025
v2.1.0
Feature

ML Travel Time Predictions & Model Retraining

Machine learning models predict travel times based on historical traffic patterns. Trigger retraining with your own fleet data for improved accuracy.

Affected Endpoints

GET/v1/portal/ml/statusPOST/v1/portal/ml/retrain
Breaking Change — action required before migration deadline
August 28, 2025
v2.0.0
Breaking

New Optimization Request Format

The optimization payload has been modernized with a flat task list, explicit vehicle profiles, and structured constraints. The legacy nested format is no longer accepted.

Migration Guide

Replace the legacy { routes: [{ stops: [...] }] } format with the new { vehicles: [...], tasks: [...], constraints: {...} } structure. See the Quick Start guide for examples. A migration script is available at github.com/mentis/optiroute-migrate.

Affected Endpoints

POST/v1/optimizePOST/v1/solve
August 15, 2025
v1.9.0
Feature

Audit Logging & Organization Invite System

All API actions are now recorded in an immutable audit log. Organization admins can invite team members with role-based access.

Affected Endpoints

GET/v1/admin/auditPOST/v1/admin/invites
August 5, 2025
v1.8.0
Feature

Multi-Objective Optimization with Configurable Weights

Balance competing objectives like total distance, number of vehicles, time window violations, and task priority using configurable weights in the optimization request.

Affected Endpoints

POST/v1/optimize