POpolymathrobotics
Vehicle Autonomy

Get the commands the robot has queued up

Changed on

Returns a snapshot of the live command queue in dispatch order, plus the id of the command currently being executed. The snapshot is refreshed once per cortex tick, so it may lag the live queue by one tick.

get/v1/vehicles/{vehicleId}/command-queue

Request

  • Base URL
    https://api.polymathrobotics.dev
  • URL
    https://api.polymathrobotics.dev/v1/vehicles/{vehicleId}/command-queue
  • Auth
    HTTP bearer

Path parameters

vehicleIdstring required

Vehicle ID issued by Polymath

Response

Queued command records, the active command id, and the number remaining.

statusstring required
messagestring required

Example response

{
  "data": {
    "queued": [
      {
        "id": "25b0db0f-083c-4cb4-9e7f-dc91613071b7",
        "summary": "NAVIGATION: geo path with 3 waypoints",
        "state": 2,
        "state_text": "TERMINAL",
        "outcome": 1,
        "outcome_text": "SUCCEEDED",
        "detail": "",
        "queued_time": {
          "sec": 1786949841,
          "nanosec": 893512222
        },
        "started_time": {
          "sec": 1786949842,
          "nanosec": 100000000
        },
        "completed_time": {
          "sec": 1786949844,
          "nanosec": 112000000
        }
      }
    ]
  }
}

Changes