Problem
Submit an optimization problem and follow it to completion. This is the core of the API - build your problem, submit it, poll for status, then read the optimized routes.
Run an optimization model
Run the optimization model specified by the input model type and data
Run an optimization model › Request Body
userIdThe User ID
The Problem object embedded within the main solve request.
exampleSlugOptional. The slug of the published example scenario this solve was loaded from (as returned by /list_examples). Published examples legitimately exceed the free tier's size limits, so sending this grants a bounded allowance sized from that example's own row counts plus a small edit margin - enough to run and tweak the demo, and never more than the named example's real size. Omit it for a user's own scenarios; an unrecognised slug is ignored.
Run an optimization model › Responses
Request accepted
problemIdThe unique identifier for this optimization run. You will want to store this locally so that you can use in your GET request for /problem.
Returns optimization status and results, if available
Returns the status of the optimization problem identified by the problemId parameter. If results are available, returns the results object.
path Parameters
problemIdThe problemId of a previously submitted problem to check the status of
Returns optimization status and results, if available › Responses
valid request
statusThe status of the optimization problem identified by the problemId parameter.
Cancel the optimization run identified by the problemId parameter
Cancel the optimization run identified by the problemId parameter. If the optimization run is already completed, this will have no effect.
path Parameters
problemIdThe problemId of a previously submitted problem to cancel
Cancel the optimization run identified by the problemId parameter › Responses
valid request