Optimiciti Developer PortalOptimiciti Developer Portal
  • Pricing
  • Documentation
  • API Reference
  • Back to Optimiciti
Information
Problem
    Submit an optimization runpostPoll a run's status (never its routes)getCancel the optimization run identified by the problemId parameterpost
Utilities
    Health Checkget
Billing
    This month's task usagegetList public plansget
History
    Get User RunspostGet Run IdspostGet Run SummariespostList Example ScenariospostGet Run ResultspostGet a published example scenariogetUpdate Run NamepostDelete Runpost
Data-processing
    Calculate a cost matrix for the given locationspost
Optimization
    Get Run StatuspostCancel Runpost
System
    Read Rootget
Schemas
powered by Zuplo
Optimiciti API Specification
Optimiciti API Specification

Optimization

Run control by run id - check a run's status, or cancel it.


Get Run Status

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

Returns the lifecycle status of a run (queued | running | succeeded | failed | cancelled) for polling. Poll every 2 to 5 seconds: a tight loop gains nothing and will run into the gateway's rate limit (429).

Get Run Status › Request Body

RunIdRequest
run_id
​string · required

The unique Run ID

Get Run Status › Responses

The run's current lifecycle status. data.status is queued, running, or a terminal succeeded / failed / cancelled. The response never carries the routes — fetch those from POST /run_results_by_run_id once the run has succeeded.

success
​boolean
​RunStatus

The run lifecycle status returned by GET /problem/{problemId} and POST /run_status. This is what a poller branches on. It is deliberately small — it never carries the routes; fetch those from POST /run_results_by_run_id once the run has succeeded.

POST/run_status
curl https://api.optimiciti.com/run_status \ --request POST \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer <token>' \ --data '{ "run_id": "run_id" }'
Example Request Body
{ "run_id": "run_id" }
json
Example Responses
{ "success": true, "data": { "run_id": "run_id", "status": "succeeded", "progress": 0, "error": "error", "error_code": "NO_FEASIBLE_SOLUTION", "run_datetime_unix": 0 } }
json
application/json

Cancel Run

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

Cancels a queued or running solve. Queued runs are skipped by the worker; running runs are cancelled best-effort.

Cancel Run › Request Body

RunIdRequest
run_id
​string · required

The unique Run ID

Cancel 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/cancel_run
curl https://api.optimiciti.com/cancel_run \ --request POST \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer <token>' \ --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

Data-processingSystem