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

Data-processing

Convert and prepare tabular data - build travel-cost matrices, import uploaded costs, and export results to Excel or JSON.


Calculate a cost matrix for the given locations

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

Calculate a cost matrix for the given locations and travel costs. This is useful for calculating travel durations and distances between locations.

Calculate a cost matrix for the given locations › Request Body

This schema defines the request body for calculating a cost matrix. It includes the locations and travel costs to use for calculating the cost matrix.
CostMatrixRequest
​Location[] · required

The locations to use for calculating the cost matrix.

costSettings
​CostSettings · required

The settings to use for calculating travel costs between locations. This includes the cost metric (duration or distance), cost multiplier, cost adder, and methods for calculating distances and durations.

​TravelCost[]

The travel costs to use for calculating the cost matrix. If not provided, the cost matrix will be calculated automatically based on the latitude and longitude of the locations. A partial cost matrix can be provided to avoid recalculating travel durations and distances between locations.

coordinateSystem
​CoordinateSystem · enum

Which coordinate family this problem's locations use. geographic (the default, and what every existing payload means) uses latitude/longitude on the Earth. cartesian uses unbounded x/y on an arbitrary plane, for scenarios with positions but no addresses. It describes the DATA, not the costing, so it is set once per request rather than per cost setting - and it decides which distance/duration methods are valid.

Enum values:
geographic
cartesian
Default: geographic

Calculate a cost matrix for the given locations › Responses

Cost matrix calculated successfully

No data returned
POST/cost_matrix
curl https://api.optimiciti.com/cost_matrix \ --request POST \ --header 'Content-Type: application/json' \ --data '{ "locations": [ {} ], "travelCosts": [ {} ], "costSettings": {}, "coordinateSystem": "geographic" }'
Example Request Body
{ "locations": [ {} ], "travelCosts": [ {} ], "costSettings": {}, "coordinateSystem": "geographic" }
json
Example Responses
No example specified for this content type

Convert To Excel

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

Converts a CSV string to an Excel file download.

Convert To Excel › Request Body

TableExportRequest
tableArray
​string · required

CSV string representation of the table

Convert To Excel › Responses

Successful Response

No data returned
POST/to_excel
curl https://api.optimiciti.com/to_excel \ --request POST \ --header 'Content-Type: application/json' \ --data '{ "tableArray": "tableArray" }'
Example Request Body
{ "tableArray": "tableArray" }
json
Example Responses
No example specified for this content type

Convert To JSON

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

Converts a CSV string to a JSON record list.

Convert To JSON › Request Body

TableExportRequest
tableArray
​string · required

CSV string representation of the table

Convert To JSON › Responses

Successful Response

No data returned
POST/to_json
curl https://api.optimiciti.com/to_json \ --request POST \ --header 'Content-Type: application/json' \ --data '{ "tableArray": "tableArray" }'
Example Request Body
{ "tableArray": "tableArray" }
json
Example Responses
No example specified for this content type

HistorySystem