History
Saved scenarios and past runs - list, open, rename, and delete a user's saved work and previous optimization runs.
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
Get detailed summaries of past runs.
Get Run Summaries › Responses
Successful Response
successIndicates if the request was successful
dataThe main response payload. Can be an object, array, boolean, or string.
List Example Scenarios
List the published example scenarios available to all users. Load one in full via /saved_scenario using its instance_id.
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 Scenario Summaries
Get summaries of saved scenarios.
Get Scenario Summaries › 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
Successful Response
successIndicates if the request was successful
dataThe main response payload. Can be an object, array, boolean, or string.
Get Saved Scenario
Get the full input state of a saved scenario.
Get Saved Scenario › Request Body
scenarioIdThe unique Scenario ID
scenarioNameOptional name to lookup example scenarios
Get Saved Scenario › Responses
Successful Response
successIndicates if the request was successful
dataThe main response payload. Can be an object, array, boolean, or string.
Get a published example scenario
Returns the full input state of a published example, addressed by its slug.
This is the cacheable twin of POST /saved_scenario. 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. Use POST /saved_scenario for a user's own saved scenarios; that route stays uncached.
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.
Delete Saved Scenario
Delete a saved scenario.
Delete Saved Scenario › Request Body
scenarioIdThe unique Scenario ID
scenarioNameOptional name to lookup example scenarios
Delete Saved Scenario › Responses
Successful Response
successIndicates if the request was successful
dataThe main response payload. Can be an object, array, boolean, or string.
Save Scenario
Save a new optimization scenario/problem state.
Save Scenario › Request Body
user_idinstance_idinput_objectinstance_nameoverwriteWhether an existing scenario with this instance_id may be replaced. When false (the default), saving onto an existing instance_id fails with 409 SCENARIO_ALREADY_EXISTS instead of silently replacing the stored scenario.
Save Scenario › Responses
Successful Response
successIndicates if the request was successful
dataThe main response payload. Can be an object, array, boolean, or string.
Rename Scenario
Rename a saved scenario.
Rename Scenario › Responses
Successful Response
successIndicates if the request was successful
dataThe main response payload. Can be an object, array, boolean, or string.
Update Scenario
Update an existing scenario with new state/data.
Update Scenario › Request Body
instance_idnew_namestateUpdate Scenario › Responses
Successful Response
successIndicates if the request was successful
dataThe main response payload. Can be an object, array, boolean, or string.
Claim Anonymous Runs
Re-owns runs submitted anonymously so they survive sign-in. Anonymous solves are stored under a throwaway client-generated user id; after the user signs in, the front end posts that id here and every run it owns is reassigned to the authenticated caller. Requires a valid bearer token — the new owner is always the verified token subject, never a value from the request body. Idempotent: re-sending returns claimed 0. Only anonymous-owned runs can be claimed; an id belonging to a signed-in account is rejected.
Claim Anonymous Runs › Request Body
anonymousUserIdThe throwaway user id the runs were submitted under while signed out.
Claim Anonymous Runs › Responses
Runs claimed. data.claimed is how many were reassigned.
successIndicates if the request was successful
dataThe main response payload. Can be an object, array, boolean, or string.
