v23

latestOpenAPI 3.1.0raw.githubusercontent.com2026-01-181345107.3 KB

Actions

Evaluate

Will trigger the evaluation run asynchronously.

post/v2/vrp/evaluate

Request body

hookstring uri nullable

Optional webhook URL that will receive a POST request with the job ID when the optimization is complete. This enables asynchronous processing where you can submit a request and be notified when results are ready, rather than waiting for the synchronous response.

labelstring nullable

Example request

{
  "jobs": [
    {
      "name": "1",
      "duration": 3600
    },
    {
      "name": "2",
      "duration": 3600
    }
  ],
  "resources": [
    {
      "name": "1"
    }
  ]
}

Response

Status

idstring required

Job ID

status'QUEUED' | 'SOLVING' | 'SOLVED' | 'ERROR' nullable

Status of the solve.

solveDurationinteger nullable

Duration of the solve in seconds

Example response

{
  "status": "SOLVING"
}