Project-OSRM · antheducation · Aug 6, 2026
diff --git a/index.html b/index.html
@@ -19,7 +19,7 @@
         <div class='col6 margin3 pad4y clearfix'>
           <div class='pad2y title '>Modern C++ routing engine for shortest paths in road networks.</div>
           <div class='center'>
-            <a href='https://map.project-osrm.org/'><input type='button' class='button' value='VIEW DEMO' name='' /></a> <a href='docs/'><input type='button' class='button' value="DOCUMENTATION" name='' /></a>
+            <a href='https://map.project-osrm.org/'><input type='button' class='button' value='VIEW DEMO' name='' /></a> <a href='docs/'><input type='button' class='button' value="DOCUMENTATION" name='' /></a> <a href='libosrm-api/'><input type='button' class='button' value="LIBOSRM C++ API" name='' /></a>
             <p class='pad2x'><a class="github-button" href="https://github.com/Project-OSRM/osrm-backend" data-icon="octicon-mark-github" data-style="mega" aria-label="View Project-OSRM/osrm-backend on GitHub">View on GitHub</a></p>
           </div>
         </div>

diff --git a/libosrm-api/README.md b/libosrm-api/README.md
@@ -0,0 +1,33 @@
+# libosrm C++ API reference — generated output
+
+Everything in this directory is generated. Do not hand-edit it.
+
+It is the rendered C++ API reference for `libosrm`, produced from the public headers of
+`Project-OSRM/osrm-backend` at pinned commit
+[`e9abd4e0268c692210c4f8e6dcd1d184ff2c8f72`](https://github.com/Project-OSRM/osrm-backend/tree/e9abd4e0268c692210c4f8e6dcd1d184ff2c8f72)
+— the tip of `master` on 2026-08-05, four commits after the `v26.8.0` release.
+
+## Regenerating
+
+The generator lives in the backend repo under `tools/api-docs/`. From a fresh checkout:
+
+```sh
+git clone https://github.com/Project-OSRM/osrm-backend && cd osrm-backend
+git checkout e9abd4e0268c692210c4f8e6dcd1d184ff2c8f72
+python tools/api-docs/build.py --output /tmp/libosrm-api
+```
+
+It needs `doxygen` and `node` on `PATH`; the renderer is fetched with
+`npx --yes sourcey@3.6.5`, pinned to an exact version. Copy the result over this directory
+**minus `_og/`** — GitHub Pages runs Jekyll on this repository and Jekyll drops
+leading-underscore paths, and those files are only social-preview images.
+
+Every file in this directory except this README is byte-for-byte what that command produces.
+
+## What is covered
+
+The scope is exactly the set of types that `docs/libosrm.md` in the backend repo tells
+embedders to go and read in the headers: `osrm::OSRM`, `EngineConfig`, `Status`, every
+`*Parameters` type under `include/engine/api`, `util::Coordinate` / `FloatCoordinate`, the
+`util::json` sum type and `storage::StorageConfig`. Each symbol page links back to the exact
+file and line at the pinned commit.
diff --git a/libosrm-api/api.html b/libosrm-api/api.html
diff --git a/libosrm-api/api/osrm-EngineConfig.html b/libosrm-api/api/osrm-EngineConfig.html
diff --git a/libosrm-api/api/osrm-MatchParameters.html b/libosrm-api/api/osrm-MatchParameters.html
diff --git a/libosrm-api/api/osrm-NearestParameters.html b/libosrm-api/api/osrm-NearestParameters.html
diff --git a/libosrm-api/api/osrm-OSRM.html b/libosrm-api/api/osrm-OSRM.html
diff --git a/libosrm-api/api/osrm-RouteParameters.html b/libosrm-api/api/osrm-RouteParameters.html
diff --git a/libosrm-api/api/osrm-TableParameters.html b/libosrm-api/api/osrm-TableParameters.html
diff --git a/libosrm-api/api/osrm-TileParameters.html b/libosrm-api/api/osrm-TileParameters.html
diff --git a/libosrm-api/api/osrm-TripParameters.html b/libosrm-api/api/osrm-TripParameters.html
diff --git a/libosrm-api/api/osrm-engine-Bearing.html b/libosrm-api/api/osrm-engine-Bearing.html
diff --git a/libosrm-api/api/osrm-engine-EngineConfig.html b/libosrm-api/api/osrm-engine-EngineConfig.html
diff --git a/libosrm-api/api/osrm-engine-Hint.html b/libosrm-api/api/osrm-engine-Hint.html
diff --git a/libosrm-api/api/osrm-engine-SegmentHint.html b/libosrm-api/api/osrm-engine-SegmentHint.html
diff --git a/libosrm-api/api/osrm-engine-api-BaseAPI.html b/libosrm-api/api/osrm-engine-api-BaseAPI.html
diff --git a/libosrm-api/api/osrm-engine-api-BaseParameters.html b/libosrm-api/api/osrm-engine-api-BaseParameters.html
diff --git a/libosrm-api/api/osrm-engine-api-MatchAPI-MatchingIndex.html b/libosrm-api/api/osrm-engine-api-MatchAPI-MatchingIndex.html
diff --git a/libosrm-api/api/osrm-engine-api-MatchAPI.html b/libosrm-api/api/osrm-engine-api-MatchAPI.html
diff --git a/libosrm-api/api/osrm-engine-api-MatchParameters.html b/libosrm-api/api/osrm-engine-api-MatchParameters.html
diff --git a/libosrm-api/api/osrm-engine-api-NearestAPI.html b/libosrm-api/api/osrm-engine-api-NearestAPI.html
diff --git a/libosrm-api/api/osrm-engine-api-NearestParameters.html b/libosrm-api/api/osrm-engine-api-NearestParameters.html
diff --git a/libosrm-api/api/osrm-engine-api-RouteAPI-GeometryVisitor.html b/libosrm-api/api/osrm-engine-api-RouteAPI-GeometryVisitor.html
diff --git a/libosrm-api/api/osrm-engine-api-RouteAPI.html b/libosrm-api/api/osrm-engine-api-RouteAPI.html
diff --git a/libosrm-api/api/osrm-engine-api-RouteParameters.html b/libosrm-api/api/osrm-engine-api-RouteParameters.html
diff --git a/libosrm-api/api/osrm-engine-api-TableAPI-TableCellRef.html b/libosrm-api/api/osrm-engine-api-TableAPI-TableCellRef.html
diff --git a/libosrm-api/api/osrm-engine-api-TableAPI.html b/libosrm-api/api/osrm-engine-api-TableAPI.html
diff --git a/libosrm-api/api/osrm-engine-api-TableParameters.html b/libosrm-api/api/osrm-engine-api-TableParameters.html
diff --git a/libosrm-api/api/osrm-engine-api-TileParameters.html b/libosrm-api/api/osrm-engine-api-TileParameters.html
diff --git a/libosrm-api/api/osrm-engine-api-TripAPI-TripIndex.html b/libosrm-api/api/osrm-engine-api-TripAPI-TripIndex.html
diff --git a/libosrm-api/api/osrm-engine-api-TripAPI.html b/libosrm-api/api/osrm-engine-api-TripAPI.html
diff --git a/libosrm-api/api/osrm-engine-api-TripParameters.html b/libosrm-api/api/osrm-engine-api-TripParameters.html
diff --git a/libosrm-api/api/osrm-engine-api-json-detail.html b/libosrm-api/api/osrm-engine-api-json-detail.html
diff --git a/libosrm-api/api/osrm-engine-api-json.html b/libosrm-api/api/osrm-engine-api-json.html
diff --git a/libosrm-api/api/osrm-engine-api-tidy-Result.html b/libosrm-api/api/osrm-engine-api-tidy-Result.html
diff --git a/libosrm-api/api/osrm-engine-api-tidy-Thresholds.html b/libosrm-api/api/osrm-engine-api-tidy-Thresholds.html
diff --git a/libosrm-api/api/osrm-engine-api-tidy.html b/libosrm-api/api/osrm-engine-api-tidy.html
diff --git a/libosrm-api/api/osrm-engine-api.html b/libosrm-api/api/osrm-engine-api.html
diff --git a/libosrm-api/api/osrm-engine-datafacade.html b/libosrm-api/api/osrm-engine-datafacade.html
diff --git a/libosrm-api/api/osrm-engine.html b/libosrm-api/api/osrm-engine.html
diff --git a/libosrm-api/api/osrm-storage-StorageConfig.html b/libosrm-api/api/osrm-storage-StorageConfig.html
diff --git a/libosrm-api/api/osrm-storage.html b/libosrm-api/api/osrm-storage.html
diff --git a/libosrm-api/api/osrm-util-Coordinate.html b/libosrm-api/api/osrm-util-Coordinate.html
diff --git a/libosrm-api/api/osrm-util-FloatCoordinate.html b/libosrm-api/api/osrm-util-FloatCoordinate.html
diff --git a/libosrm-api/api/osrm-util-json-Array.html b/libosrm-api/api/osrm-util-json-Array.html
diff --git a/libosrm-api/api/osrm-util-json-False.html b/libosrm-api/api/osrm-util-json-False.html
diff --git a/libosrm-api/api/osrm-util-json-Null.html b/libosrm-api/api/osrm-util-json-Null.html
diff --git a/libosrm-api/api/osrm-util-json-Number.html b/libosrm-api/api/osrm-util-json-Number.html
diff --git a/libosrm-api/api/osrm-util-json-Object.html b/libosrm-api/api/osrm-util-json-Object.html
diff --git a/libosrm-api/api/osrm-util-json-String.html b/libosrm-api/api/osrm-util-json-String.html
diff --git a/libosrm-api/api/osrm-util-json-True.html b/libosrm-api/api/osrm-util-json-True.html
diff --git a/libosrm-api/api/osrm-util-json.html b/libosrm-api/api/osrm-util-json.html
diff --git a/libosrm-api/api/osrm-util-tag-latitude.html b/libosrm-api/api/osrm-util-tag-latitude.html
diff --git a/libosrm-api/api/osrm-util-tag-longitude.html b/libosrm-api/api/osrm-util-tag-longitude.html
diff --git a/libosrm-api/api/osrm-util-tag-unsafelatitude.html b/libosrm-api/api/osrm-util-tag-unsafelatitude.html
diff --git a/libosrm-api/api/osrm-util-tag-unsafelongitude.html b/libosrm-api/api/osrm-util-tag-unsafelongitude.html
diff --git a/libosrm-api/api/osrm-util-tag.html b/libosrm-api/api/osrm-util-tag.html
diff --git a/libosrm-api/api/osrm-util.html b/libosrm-api/api/osrm-util.html
diff --git a/libosrm-api/api/osrm.html b/libosrm-api/api/osrm.html
diff --git a/libosrm-api/index.html b/libosrm-api/index.html
diff --git a/libosrm-api/llms-full.txt b/libosrm-api/llms-full.txt
diff --git a/libosrm-api/llms.txt b/libosrm-api/llms.txt
@@ -0,0 +1,63 @@
+# libosrm C++ API
+
+> Represents a Open Source Routing Machine with access to its services.
+
+## API Reference
+
+- [osrm](/api/osrm.html): osrm Classes Name Description OSRM Represents a Open Source Routing Machine with access to its services. EngineConfig Configures an OSRM in…
+- [OSRM](/api/osrm-OSRM.html): Represents a Open Source Routing Machine with access to its services.
+- [EngineConfig](/api/osrm-EngineConfig.html): Configures an OSRM instance.
+- [MatchParameters](/api/osrm-MatchParameters.html): Parameters specific to the OSRM Match service.
+- [NearestParameters](/api/osrm-NearestParameters.html): Parameters specific to the OSRM Nearest service.
+- [RouteParameters](/api/osrm-RouteParameters.html): Parameters specific to the OSRM Route service.
+- [TableParameters](/api/osrm-TableParameters.html): Parameters specific to the OSRM Table service.
+- [TileParameters](/api/osrm-TileParameters.html): Parameters specific to the OSRM Tile service.
+- [TripParameters](/api/osrm-TripParameters.html): Parameters specific to the OSRM Trip service.
+- [util](/api/osrm-util.html): util Classes Name Description Coordinate Represents a coordinate based on longitude and latitude in fixed representation. FloatCoordinate R…
+- [Coordinate](/api/osrm-util-Coordinate.html): Represents a coordinate based on longitude and latitude in fixed representation.
+- [FloatCoordinate](/api/osrm-util-FloatCoordinate.html): Represents a coordinate based on longitude and latitude in floating representation.
+- [engine](/api/osrm-engine.html): engine Classes Name Description Bearing EngineConfig Configures an OSRM instance. Hint Hint is deprecated. It is kept for backward-compatib…
+- [Bearing](/api/osrm-engine-Bearing.html): Bearing Copy struct Bearing Defined in include/engine/bearing.hpp:34 List of all members Name Kind Owner bearing variable Declared here ran…
+- [engine::EngineConfig](/api/osrm-engine-EngineConfig.html): Configures an OSRM instance.
+- [Hint](/api/osrm-engine-Hint.html): Hint is deprecated. It is kept for backward-compatible serialization.
+- [SegmentHint](/api/osrm-engine-SegmentHint.html): SegmentHint is deprecated.
+- [storage](/api/osrm-storage.html): storage Classes Name Description StorageConfig Configures OSRM 's file storage paths. Functions Return Name Description std::istream & oper…
+- [StorageConfig](/api/osrm-storage-StorageConfig.html): Configures OSRM's file storage paths.
+- [tag](/api/osrm-util-tag.html): tag Classes Name Description latitude longitude unsafelatitude unsafelongitude
+- [tag::latitude](/api/osrm-util-tag-latitude.html): latitude Copy struct latitude Defined in include/util/coordinate.hpp:48
+- [tag::longitude](/api/osrm-util-tag-longitude.html): longitude Copy struct longitude Defined in include/util/coordinate.hpp:51
+- [tag::unsafelatitude](/api/osrm-util-tag-unsafelatitude.html): unsafelatitude Copy struct unsafelatitude Defined in include/util/coordinate.hpp:54
+- [tag::unsafelongitude](/api/osrm-util-tag-unsafelongitude.html): unsafelongitude Copy struct unsafelongitude Defined in include/util/coordinate.hpp:57
+- [json](/api/osrm-util-json.html): json Classes Name Description String Typed string wrapper. Number Typed floating point number. True Typed True . False Typed False . Null T…
+- [json::String](/api/osrm-util-json-String.html): Typed string wrapper.
+- [json::Number](/api/osrm-util-json-Number.html): Typed floating point number.
+- [json::True](/api/osrm-util-json-True.html): Typed True.
+- [json::False](/api/osrm-util-json-False.html): Typed False.
+- [json::Null](/api/osrm-util-json-Null.html): Typed Null.
+- [json::Object](/api/osrm-util-json-Object.html): Typed Object.
+- [json::Array](/api/osrm-util-json-Array.html): Typed Array.
+- [api](/api/osrm-engine-api.html): api Classes Name Description BaseAPI MatchAPI NearestAPI RouteAPI TableAPI TripAPI BaseParameters General parameters for OSRM service queri…
+- [api::BaseAPI](/api/osrm-engine-api-BaseAPI.html): BaseAPI Copy class BaseAPI Defined in include/engine/api/base_api.hpp:22 Subclassed by: NearestAPI , RouteAPI , TableAPI List of all member…
+- [api::MatchAPI](/api/osrm-engine-api-MatchAPI.html): MatchAPI Copy class MatchAPI Defined in include/engine/api/match_api.hpp:18 Inherits: RouteAPI List of all members Name Kind Owner MatchAPI…
+- [MatchAPI::MatchingIndex](/api/osrm-engine-api-MatchAPI-MatchingIndex.html): FIXME this logic is a little backwards.
+- [api::NearestAPI](/api/osrm-engine-api-NearestAPI.html): NearestAPI Copy class NearestAPI Defined in include/engine/api/nearest_api.hpp:18 Inherits: BaseAPI List of all members Name Kind Owner par…
+- [api::RouteAPI](/api/osrm-engine-api-RouteAPI.html): RouteAPI Copy class RouteAPI Defined in include/engine/api/route_api.hpp:38 Inherits: BaseAPI Subclassed by: MatchAPI , TripAPI List of all…
+- [RouteAPI::GeometryVisitor](/api/osrm-engine-api-RouteAPI-GeometryVisitor.html): GeometryVisitor Copy template typename Builder > class GeometryVisitor Defined in include/engine/api/route_api.hpp:568 List of all members…
+- [api::TableAPI](/api/osrm-engine-api-TableAPI.html): TableAPI Copy class TableAPI Defined in include/engine/api/table_api.hpp:28 Inherits: BaseAPI List of all members Name Kind Owner TableAPI…
+- [TableAPI::TableCellRef](/api/osrm-engine-api-TableAPI-TableCellRef.html): TableCellRef Copy struct TableCellRef Defined in include/engine/api/table_api.hpp:33 List of all members Name Kind Owner row variable Decla…
+- [api::TripAPI](/api/osrm-engine-api-TripAPI.html): TripAPI Copy class TripAPI Defined in include/engine/api/trip_api.hpp:16 Inherits: RouteAPI List of all members Name Kind Owner TripAPI fun…
+- [TripAPI::TripIndex](/api/osrm-engine-api-TripAPI-TripIndex.html): TripIndex Copy struct TripIndex Defined in include/engine/api/trip_api.hpp:97 List of all members Name Kind Owner sub_trip_index variable D…
+- [api::BaseParameters](/api/osrm-engine-api-BaseParameters.html): General parameters for OSRM service queries.
+- [api::MatchParameters](/api/osrm-engine-api-MatchParameters.html): Parameters specific to the OSRM Match service.
+- [api::NearestParameters](/api/osrm-engine-api-NearestParameters.html): Parameters specific to the OSRM Nearest service.
+- [api::RouteParameters](/api/osrm-engine-api-RouteParameters.html): Parameters specific to the OSRM Route service.
+- [api::TableParameters](/api/osrm-engine-api-TableParameters.html): Parameters specific to the OSRM Table service.
+- [api::TileParameters](/api/osrm-engine-api-TileParameters.html): Parameters specific to the OSRM Tile service.
+- [api::TripParameters](/api/osrm-engine-api-TripParameters.html): Parameters specific to the OSRM Trip service.
+- [datafacade](/api/osrm-engine-datafacade.html): Fwd. decls.
+- [api::json](/api/osrm-engine-api-json.html): json Functions Return Name Description util::json::String makePolyline util::json::Object makeGeoJSONGeometry util::json::Object makeStepMa…
+- [api::tidy](/api/osrm-engine-api-tidy.html): tidy Classes Name Description Thresholds Result Typedefs Return Name Description std::vector Mask std::vector Mapping Mask Copy using Mask…
+- [tidy::Thresholds](/api/osrm-engine-api-tidy-Thresholds.html): Thresholds Copy struct Thresholds Defined in include/engine/api/match_parameters_tidy.hpp:18 List of all members Name Kind Owner distance_i…
+- [tidy::Result](/api/osrm-engine-api-tidy-Result.html): Result Copy struct Result Defined in include/engine/api/match_parameters_tidy.hpp:27 List of all members Name Kind Owner parameters variabl…
+- [json::detail](/api/osrm-engine-api-json-detail.html): detail Functions Return Name Description bool isValidModifier inline Check whether to include a modifier in the result of the API. bool has…
+- [API Reference](/api.html): Structs api::BaseParameters api::MatchParameters api::NearestParameters api::RouteParameters api::TableParameters api::TileParameters api::…
diff --git a/libosrm-api/search-index.json b/libosrm-api/search-index.json
diff --git a/libosrm-api/sitemap.xml b/libosrm-api/sitemap.xml
@@ -0,0 +1,61 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!-- Generated by Sourcey https://sourcey.com -->
+<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
+  <url><loc>/api/osrm.html</loc></url>
+  <url><loc>/api/osrm-OSRM.html</loc></url>
+  <url><loc>/api/osrm-EngineConfig.html</loc></url>
+  <url><loc>/api/osrm-MatchParameters.html</loc></url>
+  <url><loc>/api/osrm-NearestParameters.html</loc></url>
+  <url><loc>/api/osrm-RouteParameters.html</loc></url>
+  <url><loc>/api/osrm-TableParameters.html</loc></url>
+  <url><loc>/api/osrm-TileParameters.html</loc></url>
+  <url><loc>/api/osrm-TripParameters.html</loc></url>
+  <url><loc>/api/osrm-util.html</loc></url>
+  <url><loc>/api/osrm-util-Coordinate.html</loc></url>
+  <url><loc>/api/osrm-util-FloatCoordinate.html</loc></url>
+  <url><loc>/api/osrm-engine.html</loc></url>
+  <url><loc>/api/osrm-engine-Bearing.html</loc></url>
+  <url><loc>/api/osrm-engine-EngineConfig.html</loc></url>
+  <url><loc>/api/osrm-engine-Hint.html</loc></url>
+  <url><loc>/api/osrm-engine-SegmentHint.html</loc></url>
+  <url><loc>/api/osrm-storage.html</loc></url>
+  <url><loc>/api/osrm-storage-StorageConfig.html</loc></url>
+  <url><loc>/api/osrm-util-tag.html</loc></url>
+  <url><loc>/api/osrm-util-tag-latitude.html</loc></url>
+  <url><loc>/api/osrm-util-tag-longitude.html</loc></url>
+  <url><loc>/api/osrm-util-tag-unsafelatitude.html</loc></url>
+  <url><loc>/api/osrm-util-tag-unsafelongitude.html</loc></url>
+  <url><loc>/api/osrm-util-json.html</loc></url>
+  <url><loc>/api/osrm-util-json-String.html</loc></url>
+  <url><loc>/api/osrm-util-json-Number.html</loc></url>
+  <url><loc>/api/osrm-util-json-True.html</loc></url>
+  <url><loc>/api/osrm-util-json-False.html</loc></url>
+  <url><loc>/api/osrm-util-json-Null.html</loc></url>
+  <url><loc>/api/osrm-util-json-Object.html</loc></url>
+  <url><loc>/api/osrm-util-json-Array.html</loc></url>
+  <url><loc>/api/osrm-engine-api.html</loc></url>
+  <url><loc>/api/osrm-engine-api-BaseAPI.html</loc></url>
+  <url><loc>/api/osrm-engine-api-MatchAPI.html</loc></url>
+  <url><loc>/api/osrm-engine-api-MatchAPI-MatchingIndex.html</loc></url>
+  <url><loc>/api/osrm-engine-api-NearestAPI.html</loc></url>
+  <url><loc>/api/osrm-engine-api-RouteAPI.html</loc></url>
+  <url><loc>/api/osrm-engine-api-RouteAPI-GeometryVisitor.html</loc></url>
+  <url><loc>/api/osrm-engine-api-TableAPI.html</loc></url>
+  <url><loc>/api/osrm-engine-api-TableAPI-TableCellRef.html</loc></url>
+  <url><loc>/api/osrm-engine-api-TripAPI.html</loc></url>
+  <url><loc>/api/osrm-engine-api-TripAPI-TripIndex.html</loc></url>
+  <url><loc>/api/osrm-engine-api-BaseParameters.html</loc></url>
+  <url><loc>/api/osrm-engine-api-MatchParameters.html</loc></url>
+  <url><loc>/api/osrm-engine-api-NearestParameters.html</loc></url>
+  <url><loc>/api/osrm-engine-api-RouteParameters.html</loc></url>
+  <url><loc>/api/osrm-engine-api-TableParameters.html</loc></url>
+  <url><loc>/api/osrm-engine-api-TileParameters.html</loc></url>
+  <url><loc>/api/osrm-engine-api-TripParameters.html</loc></url>
+  <url><loc>/api/osrm-engine-datafacade.html</loc></url>
+  <url><loc>/api/osrm-engine-api-json.html</loc></url>
+  <url><loc>/api/osrm-engine-api-tidy.html</loc></url>
+  <url><loc>/api/osrm-engine-api-tidy-Thresholds.html</loc></url>
+  <url><loc>/api/osrm-engine-api-tidy-Result.html</loc></url>
+  <url><loc>/api/osrm-engine-api-json-detail.html</loc></url>
+  <url><loc>/api.html</loc></url>
+</urlset>
diff --git a/libosrm-api/sourcey.css b/libosrm-api/sourcey.css
diff --git a/libosrm-api/sourcey.js b/libosrm-api/sourcey.js