Pricing

Documentation
API Reference
Back to Optimiciti

Submit an optimization runpost

Poll a run's status (never its routes)get

Cancel the optimization run identified by the problemId parameterpost

Health Checkget

This month's task usageget

List public plansget

Get User Runspost

Get Run Idspost

Get Run Summariespost

List Example Scenariospost

Get Run Resultspost

Get a published example scenarioget

Update Run Namepost

Data-processing

Calculate a cost matrix for the given locationspost

Get Run Statuspost

powered by Zuplo

Optimiciti API Specification

Optimiciti API Specification

Utilities

Health check - confirm the API is up and answering.

Health Check

GET

https://api.optimiciti.com

/health

Returns the operational status of the API.

Health Check › 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.

GET/health

curl https://api.optimiciti.com/health

Example Responses

{
  "success": true,
  "data": {},
  "error": {
    "code": "code",
    "message": "message",
    "details": {}
  }
}

json

application/json

Problem Billing