History
Past runs and published examples - list a user's previous optimization runs, re-open their results, rename or delete them, and browse the example scenarios.
Get User Runs
Get a list of all run IDs and timestamps for a user.
Get User Runs › Responses
Successful Response
successIndicates if the request was successful
dataThe main response payload. Can be an object, array, boolean, or string.
Get Run Ids
Get the list of run IDs for a user.
Get Run Ids › Responses
Successful Response
successIndicates if the request was successful
dataThe main response payload. Can be an object, array, boolean, or string.
Get Run Summaries
The caller's runs, newest first, one entry per run keyed by its run_id, with the run's lifecycle status, its submission time, its summary, and its run_name if it was renamed with POST /update_run_name. Since 2026-09-18 run_datetime_unix is an integer here, the same type POST /user_runs returns for the same row (it was a string). Runs finished before 2026-09-18 carry an empty summary ({}): the summary row was never written before then, and there is no backfill.
Get Run Summaries › Responses
The caller's runs, newest first. data is an array; each element is an object with a single key, the run_id, whose value is a RunSummaryEntry.
successList Example Scenarios
List the published example scenarios available to all users. Load one in full with GET /example_scenario/{slug}, using its slug.
List Example Scenarios › Responses
Successful Response
successIndicates if the request was successful
dataThe main response payload. Can be an object, array, boolean, or string.
Get Run Results
Get the full results of a specific optimization run.
Get Run Results › Responses
The optimized plan. data is a ProblemResponse with two parts: data.problemResult (the routes — read them from data.problemResult.routeStopsFull) and data.resultSummary (assignment/route/cost/timing totals). Before trusting the result, check that nothing was left unassigned: in data.resultSummary.assignmentSummary.locationsAssigned, assigned must equal total. (total does not count depots, so it is not the number of locations you sent.) To check independently, every non-depot location you submitted should appear as a stop in data.problemResult.routeStopsFull.
successThe complete response for a solved optimization problem, combining the full result data with a high-level summary.
Get a published example scenario
Returns the full input state of a published example, addressed by its slug (as returned by POST /list_examples).
Examples are public and immutable between seeds, so this route is a GET keyed entirely by its URL and carries a Cache-Control header — a gateway or CDN can serve it without inspecting a request body or knowing who is asking.
It can only ever return an example: the slug is resolved through the example index and the resolved record's owner is re-checked against the examples account, so a private scenario cannot be served from this path even if the index were wrong.
path Parameters
slugThe example's slug, as published on /list_examples (e.g. tokyo-home-health-occupational-therapy).
Get a published example scenario › Responses
Successful Response
successIndicates if the request was successful
dataThe main response payload. Can be an object, array, boolean, or string.
Update Run Name
Update the name of a specific run.
Update Run Name › Responses
Successful Response
successIndicates if the request was successful
dataThe main response payload. Can be an object, array, boolean, or string.
Delete Run
Delete a specific optimization run.
Delete Run › Responses
Successful Response
successIndicates if the request was successful
dataThe main response payload. Can be an object, array, boolean, or string.