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

Billing

Plans and limits - the public plan tiers, each with its limits and feature flags.


This month's task usage

GET
https://api.optimiciti.com
/usage

How many optimization tasks the calling account has used this UTC month, and how many its plan includes. The same object every 202 from POST /problem carries, on its own, for dashboards. Requires a verified identity: on api.optimiciti.com send your API key.

This month's task usage › Responses

This month's usage.

success
​boolean
​UsageSummary

This UTC month's optimization-task usage for the calling account. Present on every 202 from POST /problem for plans that include a monthly allowance, and returned by GET /usage. Absent from the 202 for plans that do not meter tasks (the web tiers).

GET/usage
curl https://api.optimiciti.com/usage \ --header 'Authorization: Bearer <token>'
Example Responses
{ "success": true, "data": { "tasksUsed": 9840, "tasksIncluded": 10000, "period": "2026-09", "resetsAt": "2026-10-01T00:00:00Z", "plan": "developer" } }
json
application/json

List public plans

GET
https://api.optimiciti.com
/plans

Public source of truth for pricing and entitlements: the subscribable tiers, each with its display name, resolved limits, and feature flags. No auth and no request body. Front-end pricing tables and marketing JSON-LD should read limits from here instead of restating them. data is an array of PublicPlan objects.

Optional display copy — description (string) and highlights (string[]) — is included only for tiers that declare it, so the pricing page can source prose here too rather than keeping a second copy. Absent rather than null when unwritten. This copy is configuration, not a live mirror of the billing provider: this endpoint deliberately makes no third-party call, so pricing stays up when billing does not.

List public plans › Responses

The subscribable plan tiers.

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/plans
curl https://api.optimiciti.com/plans
Example Responses
{ "success": true, "data": {}, "error": { "code": "code", "message": "message", "details": {} } }
json
application/json

UtilitiesHistory