POpolymathrobotics
Vehicle Autonomy

Get the history of commands the robot has finished

Changed on

Returns command records that have reached a terminal state, newest first, from cortex's bounded history ring. Each record carries the command id that was returned when the command was submitted, so a caller can look up how one of its own commands ended. Filters are optional and combine.

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

Request

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

Path parameters

vehicleIdstring required

Vehicle ID issued by Polymath

Query parameters

max_countinteger

Maximum number of records to return. Zero means no limit.

since_secinteger

Only return records completed at or after this time, in seconds. Zero disables.

since_nanosecinteger

Nanosecond part of the since filter.

command_idstring

Only return the record with this command id. Empty disables the filter.

Response

Terminal command records, newest first.

statusstring required
messagestring required

Example response

{
  "data": {
    "records": [
      {
        "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