Meta Endpoints

Two lightweight endpoints for liveness checks and feature discovery. Neither requires a request body.

Health

GET /health

Liveness probe, suitable for a load balancer or container orchestrator health check. Always returns 200 if the process is up.

{ "status": "ok", "version": "2.0.0" }

curl https://api.fieldgenius.be/health

import httpx

resp = httpx.get("https://api.fieldgenius.be/health")
assert resp.json()["status"] == "ok"

Capabilities

GET /capabilities

Returns the solver feature catalogue: supported feature flags, objective types, first-solution strategies, and local-search metaheuristics. Useful for a client to introspect what the deployed version supports before constructing a request.

Name	Type	Required	Default	Description
version	string	optional	-	Solver/API version string.
features	string[]	optional	-	Flat list of supported feature names (e.g. `time_windows`, `skills`, `multi_day`, `dynamic_replanning`).
objectives	string[]	optional	-	Supported `ObjectiveType` values.
first_solution_strategies	string[]	optional	-	Supported first-solution strategy names.
local_search_metaheuristics	string[]	optional	-	Supported local-search metaheuristic names.
max_matrix_size	integer \| null	optional	null	Not currently enforced; reserved for a future hard limit.

curl https://api.fieldgenius.be/capabilities

import httpx

resp = httpx.get("https://api.fieldgenius.be/capabilities")
caps = resp.json()
print(caps["features"])
print(caps["objectives"])

Example response:

{
  "version": "2.0.0",
  "features": [
    "basic_vrp", "optional_jobs", "service_times", "time_windows",
    "vehicle_eligibility", "skills", "capacity_single", "capacity_named_multi",
    "dump_stations", "shipments_pickup_delivery", "precedence", "sequence",
    "same_route", "different_route", "breaks", "multi_day",
    "dynamic_replanning", "zones", "max_tasks", "fairness_balance",
    "async_solve", "evaluate", "suggest_insertion", "reoptimize"
  ],
  "objectives": ["min_distance", "min_time", "min_vehicles", "maximize_served", "balance_workload"],
  "first_solution_strategies": [
    "AUTOMATIC", "PATH_CHEAPEST_ARC", "PATH_MOST_CONSTRAINED_ARC",
    "PARALLEL_CHEAPEST_INSERTION", "LOCAL_CHEAPEST_INSERTION",
    "GLOBAL_CHEAPEST_ARC", "SAVINGS", "CHRISTOFIDES"
  ],
  "local_search_metaheuristics": [
    "AUTOMATIC", "GREEDY_DESCENT", "GUIDED_LOCAL_SEARCH",
    "SIMULATED_ANNEALING", "TABU_SEARCH", "GENERIC_TABU_SEARCH"
  ]
}

Content gap: some newer features are not listed

The features list in the current source code does not include traffic_segments, mixed_fleet, skill_proficiency, multi_objective, or soft_time_windows even though all of these are implemented (see the corresponding feature docs). This catalogue has not been kept in sync with newer features; treat it as a partial list. Noted in CONTENT_GAPS.md.