Routite API · Optimization API

The solver, as a service you can call

The API gives TMS vendors, platforms and in-house teams the same GPU solver the console uses: post a problem, ask for a re-solve, get routes, diffs and reasons back.

A call, step by step

  1. SubmitVehicles, stops, rules
  2. SolveGPU job
  3. NotifyWebhook or poll
  4. ReadRoutes, diff, reasons
POST /v1/solve · draft
POST /v1/solve
{
  "vehicles": [{ "id": "van-1", "depot": "d4", "capacity": [120] }],
  "stops": [{ "id": "s-214", "lat": 52.37, "lon": 4.90,
              "window": ["12:00", "14:00"], "demand": [3] }],
  "objective": ["lateness", "distance"]
}
→ 202 Accepted · job_7f3a · poll or receive a webhook

Job result · job_7f3a

Example
  • statussolved
  • vehicles used5
  • stops412
  • solve time3.8 s
  • late stops0
Example An example response summary. Values are illustrative; the API is in design.

Stop 01 · Capabilities

What API does

Solve

One-off solves

Post a full problem and get back a plan.

Re-solve

Change-based solves

Send only the event; Routite re-solves from the current plan.

Diff

What changed

Each result lists moved stops and new ETAs.

Reasons

Why it changed

Machine-readable reasons per moved stop.

Async

Jobs and webhooks

Large problems run as jobs with a webhook when done.

Keys

Scoped API keys

Keys per environment and region, with usage reports.

Stop 02 · Data formats

What goes in and comes out

Connectors for named TMS, WMS and telematics products are planned; none is built or endorsed by those vendors yet.
FormatUsed forDirectionStatus
JSONProblems, plans, diffs, reasonsIn and outIn build
CSVBulk orders and history for replaysInIn build
GeoJSONRoutes and zones for mapsOutIn build
WebhooksPlan ready, change approved, stop servedOutIn build
TMS and WMS connectorsOrders in, routes outBothPlanned
Telematics feedsGPS and vehicle statusInPlanned

Stop 03 · How it works

How API works

  1. submitrequest

    Submit

    A problem or an event, as JSON.

    Auth API key
  2. solveGPU

    Solve

    The job runs on cuOpt in Routite cloud.

    Target <10 s regional
  3. returnwebhook

    Return

    Plan, diff and reasons, by webhook or polling.

    Format JSON, GeoJSON

Stop 04 · Specification

Specification

Draft specification. Figures are design targets, not measured results.
ItemDetailStatus
ProtocolHTTPS, JSON, RESTIn design
AuthScoped API keys; OAuth plannedIn design
LimitsUp to 10,000 stops per problemDesign target
SDKsPython and TypeScriptPlanned

Stop 05 · Place in the loop

Where API sits

The API is a branch off the loop: the same engine as Optimize, for teams that want to build their own console or embed routing in theirs.

Return leg Edge sends real arrival and service times back to Twin. ETA and demand models retrain on them, so tomorrow's first plan starts closer to reality.

Stop 06 · Questions

Questions dispatch teams ask

Can we get early access?

Design partners get the draft API first. Write to the engineering address on the contact page.

Is it priced per call?

Pricing is by usage of solves and re-solves; see the pricing page. We do not publish prices yet.

Will there be a sandbox?

Yes, with synthetic cities, planned for the first API release.

Stop 07 · Destination

Next step

See API on your own data

A replay of one past day shows what this product would have done, with every assumption written down.