Optimiciti Developer PortalOptimiciti Developer Portal
  • Pricing
  • Documentation
  • API Reference
  • Your API Key
Information
Problem
    Run an optimization modelpostReturns optimization status and results, if availablegetCancel the optimization run identified by the problemId parameterpost
Utilities
    Health Checkget
Billing
    List public plansget
History
    Get User RunspostGet Run IdspostGet Run SummariespostList Example ScenariospostGet Scenario SummariespostGet Run ResultspostGet Saved ScenariopostGet a published example scenariogetUpdate Run NamepostDelete RunpostDelete Saved ScenariopostSave ScenariopostRename ScenariopostUpdate ScenariopostClaim Anonymous Runspost
Data-processing
    Calculate a cost matrix for the given locationspostConvert To ExcelpostConvert To JSONpost
System
    Read Rootget
Optimization
    Get Run StatuspostCancel Runpost
Schemas
powered by Zuplo
Optimiciti API Specification
Optimiciti API Specification

History

Saved scenarios and past runs - list, open, rename, and delete a user's saved work and previous optimization runs.


Get User Runs

POST
https://api.optimiciti.com
/user_runs

Get a list of all run IDs and timestamps for a user.

Get User Runs › Request Body

UserHistoryRequest
user_id
​string · required

The unique User ID

Get User Runs › Responses

Successful Response

A standardized response envelope used across the API.
StandardResponse
success
​boolean

Indicates if the request was successful

Default: true
data
​

The main response payload. Can be an object, array, boolean, or string.

​ResponseError
POST/user_runs
curl https://api.optimiciti.com/user_runs \ --request POST \ --header 'Content-Type: application/json' \ --data '{ "user_id": "user_id" }'
Example Request Body
{ "user_id": "user_id" }
json
Example Responses
{ "success": true, "data": {}, "error": { "code": "code", "message": "message", "details": {} } }
json
application/json

Get Run Ids

POST
https://api.optimiciti.com
/run_ids_by_user

Get the list of run IDs for a user.

Get Run Ids › Request Body

UserHistoryRequest
user_id
​string · required

The unique User ID

Get Run Ids › Responses

Successful Response

A standardized response envelope used across the API.
StandardResponse
success
​boolean

Indicates if the request was successful

Default: true
data
​

The main response payload. Can be an object, array, boolean, or string.

​ResponseError
POST/run_ids_by_user
curl https://api.optimiciti.com/run_ids_by_user \ --request POST \ --header 'Content-Type: application/json' \ --data '{ "user_id": "user_id" }'
Example Request Body
{ "user_id": "user_id" }
json
Example Responses
{ "success": true, "data": {}, "error": { "code": "code", "message": "message", "details": {} } }
json
application/json

Get Run Summaries

POST
https://api.optimiciti.com
/run_summaries_by_user

Get detailed summaries of past runs.

Get Run Summaries › Request Body

UserHistoryRequest
user_id
​string · required

The unique User ID

Get Run Summaries › Responses

Successful Response

A standardized response envelope used across the API.
StandardResponse
success
​boolean

Indicates if the request was successful

Default: true
data
​

The main response payload. Can be an object, array, boolean, or string.

​ResponseError
POST/run_summaries_by_user
curl https://api.optimiciti.com/run_summaries_by_user \ --request POST \ --header 'Content-Type: application/json' \ --data '{ "user_id": "user_id" }'
Example Request Body
{ "user_id": "user_id" }
json
Example Responses
{ "success": true, "data": {}, "error": { "code": "code", "message": "message", "details": {} } }
json
application/json

List Example Scenarios

POST
https://api.optimiciti.com
/list_examples

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

A standardized response envelope used across the API.
StandardResponse
success
​boolean

Indicates if the request was successful

Default: true
data
​

The main response payload. Can be an object, array, boolean, or string.

​ResponseError
POST/list_examples
curl https://api.optimiciti.com/list_examples \ --request POST
Example Responses
{ "success": true, "data": {}, "error": { "code": "code", "message": "message", "details": {} } }
json
application/json

Get Scenario Summaries

POST
https://api.optimiciti.com
/scenario_summaries_by_user

Get summaries of saved scenarios.

Get Scenario Summaries › Request Body

UserHistoryRequest
user_id
​string · required

The unique User ID

Get Scenario Summaries › Responses

Successful Response

A standardized response envelope used across the API.
StandardResponse
success
​boolean

Indicates if the request was successful

Default: true
data
​

The main response payload. Can be an object, array, boolean, or string.

​ResponseError
POST/scenario_summaries_by_user
curl https://api.optimiciti.com/scenario_summaries_by_user \ --request POST \ --header 'Content-Type: application/json' \ --data '{ "user_id": "user_id" }'
Example Request Body
{ "user_id": "user_id" }
json
Example Responses
{ "success": true, "data": {}, "error": { "code": "code", "message": "message", "details": {} } }
json
application/json

Get Run Results

POST
https://api.optimiciti.com
/run_results_by_run_id

Get the full results of a specific optimization run.

Get Run Results › Request Body

RunIdRequest
run_id
​string · required

The unique Run ID

Get Run Results › Responses

Successful Response

A standardized response envelope used across the API.
StandardResponse
success
​boolean

Indicates if the request was successful

Default: true
data
​

The main response payload. Can be an object, array, boolean, or string.

​ResponseError
POST/run_results_by_run_id
curl https://api.optimiciti.com/run_results_by_run_id \ --request POST \ --header 'Content-Type: application/json' \ --data '{ "run_id": "run_id" }'
Example Request Body
{ "run_id": "run_id" }
json
Example Responses
{ "success": true, "data": {}, "error": { "code": "code", "message": "message", "details": {} } }
json
application/json

Get Saved Scenario

POST
https://api.optimiciti.com
/saved_scenario

Get the full input state of a saved scenario.

Get Saved Scenario › Request Body

ScenarioRequest
scenarioId
​string | null

The unique Scenario ID

scenarioName
​string | null

Optional name to lookup example scenarios

Get Saved Scenario › Responses

Successful Response

A standardized response envelope used across the API.
StandardResponse
success
​boolean

Indicates if the request was successful

Default: true
data
​

The main response payload. Can be an object, array, boolean, or string.

​ResponseError
POST/saved_scenario
curl https://api.optimiciti.com/saved_scenario \ --request POST \ --header 'Content-Type: application/json' \ --data '{ "scenarioId": "scenarioId", "scenarioName": "scenarioName" }'
Example Request Body
{ "scenarioId": "scenarioId", "scenarioName": "scenarioName" }
json
Example Responses
{ "success": true, "data": {}, "error": { "code": "code", "message": "message", "details": {} } }
json
application/json

Get a published example scenario

GET
https://api.optimiciti.com
/example_scenario/{slug}

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.

Get a published example scenario › path Parameters

slug
​string · required · explode: true

The example's slug, as published on /list_examples (e.g. tokyo-home-health-occupational-therapy).

Get a published example scenario › Responses

Successful Response

A standardized response envelope used across the API.
StandardResponse
success
​boolean

Indicates if the request was successful

Default: true
data
​

The main response payload. Can be an object, array, boolean, or string.

​ResponseError
GET/example_scenario/{slug}
curl https://api.optimiciti.com/example_scenario/:slug
Example Responses
{ "success": true, "data": {}, "error": { "code": "code", "message": "message", "details": {} } }
json
application/json

Update Run Name

POST
https://api.optimiciti.com
/update_run_name

Update the name of a specific run.

Update Run Name › Request Body

UpdateRunRequest
run_id
​string · required
run_name
​string · required

Update Run Name › Responses

Successful Response

A standardized response envelope used across the API.
StandardResponse
success
​boolean

Indicates if the request was successful

Default: true
data
​

The main response payload. Can be an object, array, boolean, or string.

​ResponseError
POST/update_run_name
curl https://api.optimiciti.com/update_run_name \ --request POST \ --header 'Content-Type: application/json' \ --data '{ "run_id": "run_id", "run_name": "run_name" }'
Example Request Body
{ "run_id": "run_id", "run_name": "run_name" }
json
Example Responses
{ "success": true, "data": {}, "error": { "code": "code", "message": "message", "details": {} } }
json
application/json

Delete Run

POST
https://api.optimiciti.com
/delete_run

Delete a specific optimization run.

Delete Run › Request Body

RunIdRequest
run_id
​string · required

The unique Run ID

Delete Run › Responses

Successful Response

A standardized response envelope used across the API.
StandardResponse
success
​boolean

Indicates if the request was successful

Default: true
data
​

The main response payload. Can be an object, array, boolean, or string.

​ResponseError
POST/delete_run
curl https://api.optimiciti.com/delete_run \ --request POST \ --header 'Content-Type: application/json' \ --data '{ "run_id": "run_id" }'
Example Request Body
{ "run_id": "run_id" }
json
Example Responses
{ "success": true, "data": {}, "error": { "code": "code", "message": "message", "details": {} } }
json
application/json

Delete Saved Scenario

POST
https://api.optimiciti.com
/delete_saved_scenario

Delete a saved scenario.

Delete Saved Scenario › Request Body

ScenarioRequest
scenarioId
​string | null

The unique Scenario ID

scenarioName
​string | null

Optional name to lookup example scenarios

Delete Saved Scenario › Responses

Successful Response

A standardized response envelope used across the API.
StandardResponse
success
​boolean

Indicates if the request was successful

Default: true
data
​

The main response payload. Can be an object, array, boolean, or string.

​ResponseError
POST/delete_saved_scenario
curl https://api.optimiciti.com/delete_saved_scenario \ --request POST \ --header 'Content-Type: application/json' \ --data '{ "scenarioId": "scenarioId", "scenarioName": "scenarioName" }'
Example Request Body
{ "scenarioId": "scenarioId", "scenarioName": "scenarioName" }
json
Example Responses
{ "success": true, "data": {}, "error": { "code": "code", "message": "message", "details": {} } }
json
application/json

Save Scenario

POST
https://api.optimiciti.com
/save_instance

Save a new optimization scenario/problem state.

Save Scenario › Request Body

SaveScenarioRequest
user_id
​string · required
instance_id
​string · required
input_object
​object · required
instance_name
​string
Default:
overwrite
​boolean

Whether 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.

Default: false

Save Scenario › Responses

Successful Response

A standardized response envelope used across the API.
StandardResponse
success
​boolean

Indicates if the request was successful

Default: true
data
​

The main response payload. Can be an object, array, boolean, or string.

​ResponseError
POST/save_instance
curl https://api.optimiciti.com/save_instance \ --request POST \ --header 'Content-Type: application/json' \ --data '{ "user_id": "user_id", "instance_id": "instance_id", "input_object": {}, "instance_name": "", "overwrite": false }'
Example Request Body
{ "user_id": "user_id", "instance_id": "instance_id", "input_object": {}, "instance_name": "", "overwrite": false }
json
Example Responses
{ "success": true, "data": {}, "error": { "code": "code", "message": "message", "details": {} } }
json
application/json

Rename Scenario

POST
https://api.optimiciti.com
/rename_instance

Rename a saved scenario.

Rename Scenario › Request Body

RenameScenarioRequest
instance_id
​string · required
new_name
​string · required

Rename Scenario › Responses

Successful Response

A standardized response envelope used across the API.
StandardResponse
success
​boolean

Indicates if the request was successful

Default: true
data
​

The main response payload. Can be an object, array, boolean, or string.

​ResponseError
POST/rename_instance
curl https://api.optimiciti.com/rename_instance \ --request POST \ --header 'Content-Type: application/json' \ --data '{ "instance_id": "instance_id", "new_name": "new_name" }'
Example Request Body
{ "instance_id": "instance_id", "new_name": "new_name" }
json
Example Responses
{ "success": true, "data": {}, "error": { "code": "code", "message": "message", "details": {} } }
json
application/json

Update Scenario

POST
https://api.optimiciti.com
/update_instance

Update an existing scenario with new state/data.

Update Scenario › Request Body

UpdateScenarioRequest
instance_id
​string · required
new_name
​string · required
state
​object · required

Update Scenario › Responses

Successful Response

A standardized response envelope used across the API.
StandardResponse
success
​boolean

Indicates if the request was successful

Default: true
data
​

The main response payload. Can be an object, array, boolean, or string.

​ResponseError
POST/update_instance
curl https://api.optimiciti.com/update_instance \ --request POST \ --header 'Content-Type: application/json' \ --data '{ "instance_id": "instance_id", "new_name": "new_name", "state": {} }'
Example Request Body
{ "instance_id": "instance_id", "new_name": "new_name", "state": {} }
json
Example Responses
{ "success": true, "data": {}, "error": { "code": "code", "message": "message", "details": {} } }
json
application/json

Claim Anonymous Runs

POST
https://api.optimiciti.com
/claim_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

ClaimRunsRequest
anonymousUserId
​string · required

The throwaway user id the runs were submitted under while signed out.

Example: 7c1f0a2e-9b3d-4c5a-8e2f-1d6b7a8c9e01

Claim Anonymous Runs › Responses

Runs claimed. data.claimed is how many were reassigned.

A standardized response envelope used across the API.
StandardResponse
success
​boolean

Indicates if the request was successful

Default: true
data
​

The main response payload. Can be an object, array, boolean, or string.

​ResponseError
POST/claim_runs
curl https://api.optimiciti.com/claim_runs \ --request POST \ --header 'Content-Type: application/json' \ --data '{ "anonymousUserId": "7c1f0a2e-9b3d-4c5a-8e2f-1d6b7a8c9e01" }'
Example Request Body
{ "anonymousUserId": "7c1f0a2e-9b3d-4c5a-8e2f-1d6b7a8c9e01" }
json
Example Responses
{ "success": true, "data": {}, "error": { "code": "code", "message": "message", "details": {} } }
json
application/json

BillingData-processing