Optimization

Flexible GET

get/optimization/v2/result

Query parameters

keystring 32 character alphanumeric string required

Example:key=API_KEY

A key is a unique identifier that is required to authenticate a request to the API.

idstring required

The unique ID that was returned on successful submission of the Optimization POST request.

Response

descriptionstring

Returns the description of the optimization job as given in the input POST optimization request. This field will not be present in the response if no description was provided in the input request.

status'Ok' | 'Error'

It indicates the overall status or result of the API request denoting whether the operation was successful or did it encounter any errors.

messagestring

Returns the message in case of errors or failures, otherwise a blank string is returned.

Example response

{
  "result": {
    "error": "Error Input: not able to allocate vehicle to fulfill all input relations"
  }
}

Changes

Changed in 3 of the 15 revisions of this API.66

Jul 31, 20257ee76f0ff67922See the full diff
- ●
  added the new Error enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new Ok enum value to the response property for the response status
  response-property-enum-value-added
- ○
  removed the Error enum value from the response property for the response status
  response-property-enum-value-removed
- ○
  removed the Ok enum value from the response property for the response status
  response-property-enum-value-removed
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 31, 2025a800b73f11c122See the full diff
- ●
  added the new Error enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new Ok enum value to the response property for the response status
  response-property-enum-value-added
- ○
  removed the Error enum value from the response property for the response status
  response-property-enum-value-removed
- ○
  removed the Ok enum value from the response property for the response status
  response-property-enum-value-removed
Jul 30, 2025b79d96775b1322See the full diff
- ●
  added the new Error enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new Ok enum value to the response property for the response status
  response-property-enum-value-added
- ○
  removed the Error enum value from the response property for the response status
  response-property-enum-value-removed
- ○
  removed the Ok enum value from the response property for the response status
  response-property-enum-value-removed

Full history