Skip to content

50,000 free calls a month, card-free. Get an API key →

Documentation menu
docs / api / post-v1-jobs-optimise
routing

POST/v1/jobs/optimise

API key required, sent as Authorization: Bearer snk_… or ?api_key=snk_….

Call it

bash
curl -fsS -X POST "https://api.mapmap.ai/v1/jobs/optimise" \
  -H "Authorization: Bearer $MAPMAP_KEY" \
  -H "Content-Type: application/json" \
  -d @request.json

Request body

application/json

Exactly the POST /optimise body: vehicles, jobs, optional shipments, costing, costing_options, adr, eu_drivers_hours, plus an optional webhook_url. The unique-location cap here is SN_OPTIMISE_MAX_LOCATIONS_ASYNC (2,000 by default), ten times the synchronous 200: the synchronous cap is bound by the request deadline, and there is no request to hold open here

The OpenAPI document declares this body as a free-form JSON object with no field list, so there is nothing here to generate a table from. The prose above is what the gateway states about it; the raw document is the authority.

Responses

202Accepted and queued. Poll result_url, or wait for the signed webhook
FieldTypeRequiredDescription
idstringyesThe job id to poll.
kindstringyesoptimise, replan or matrix.
result_urlstringyesWhere to fetch it. The same URL the webhook will carry.
statusstringyesAlways queued — the worker has not looked at it yet.
units_chargedintegeryesQuota units this submission drew. Charged now, refunded in full if the job fails.
400Invalid problem, or an unusable webhook_url (must be https and publicly resolvable)
401Missing or invalid API key
409A webhook_url was given but the key has no webhook signing secret
422More than SN_OPTIMISE_MAX_LOCATIONS_ASYNC unique locations
429Quota, rate limit, or too many jobs already queued or running
503Optimisation is not enabled on this deployment (SN_VROOM_URL unset)

Error bodies follow the shared problem model documented on API conventions.

Also under routing

Generated from https://api.mapmap.ai/openapi.json on 2026-09-17 · operationId post_optimise_job