Polymath API (Preview)

Preview

The Polymath API is live and available for evaluation. Its routes and contracts may change before the preview ends. Contact Polymath before using it in production.

All preview endpoints, grouped by function. Click any endpoint to see its full request/response documentation.

↓ Download OpenAPI spec

Clients authenticate with an access token sent with the Bearer scheme. See Authentication.

Vehicles

Find vehicles your API client can access.

GET/v1/vehiclesList vehicles

Power

Check a vehicle's power state and request power changes.

GET/v1/vehicles/{vehicleId}/power/statusGet vehicle power statusPOST/v1/vehicles/{vehicleId}/power/onRequest vehicle power onPOST/v1/vehicles/{vehicleId}/power/offRequest vehicle power off

Health Check

Contains UUID endpoint that can be used to health check the robot

GET/v1/vehicles/{vehicleId}/healthSystem health check endpoint

Vehicle Autonomy

All endpoints related to interacting with Robot's autonomy operations here

GET/v1/vehicles/{vehicleId}/feedbackGet the combined Autonomy, Navigation and Vehicle feedback from the Polymath systemPOST/v1/vehicles/{vehicleId}/gps-waypointsSend a set of gps waypoints to the robotPOST/v1/vehicles/{vehicleId}/motion-commandSend a motion command to the robot to change its current stateGET/v1/vehicles/{vehicleId}/motion-commandsGet the available motion commandsGET/v1/vehicles/{vehicleId}/navigation-path-optionsGet the available Navigation Path Options and associated ParametersGET/v1/vehicles/{vehicleId}/reference-targetsGet all previously set reference targetsPOST/v1/vehicles/{vehicleId}/reference-targetsSet the location and details of a reference location or an objectPOST/v1/vehicles/{vehicleId}/reference-targets/current-locationSet a reference target at the current robot locationPOST/v1/vehicles/{vehicleId}/relative-waypointsSend a set of relative waypoints to the robot

Vehicle Operations

All endpoints related to interacting with Robot's vehicle operations here

POST/v1/vehicles/{vehicleId}/vehicle-commandSend a vehicle command to the robotGET/v1/vehicles/{vehicleId}/vehicle-commandsGet the available Vehicle Commands and associated Parameters

Site Management

GET/v1/vehicles/{vehicleId}/active-siteRead the currently active siteGET/v1/vehicles/{vehicleId}/sitesList all sites on the vehicleGET/v1/vehicles/{vehicleId}/sites/{name}Read a named site in fullPOST/v1/vehicles/{vehicleId}/sites/{name}Create a sitePUT/v1/vehicles/{vehicleId}/sites/{name}Update an existing siteDELETE/v1/vehicles/{vehicleId}/sites/{name}Delete a named sitePOST/v1/vehicles/{vehicleId}/sites/{name}/activateStage a site for activation

Route Management

GET/v1/vehicles/{vehicleId}/loaded-routeRead the currently loaded routeGET/v1/vehicles/{vehicleId}/routesList all routes on the vehicleGET/v1/vehicles/{vehicleId}/routes/{name}Read a named route in fullPOST/v1/vehicles/{vehicleId}/routes/{name}Create a routePUT/v1/vehicles/{vehicleId}/routes/{name}Update existing routeDELETE/v1/vehicles/{vehicleId}/routes/{name}Delete a named routePOST/v1/vehicles/{vehicleId}/routes/{name}/loadLoad a route for navigation

Zone Set Management

GET/v1/vehicles/{vehicleId}/loaded-zone-setRead the currently loaded zone setPOST/v1/vehicles/{vehicleId}/loaded-zone-set/clearClear the currently loaded zone setPATCH/v1/vehicles/{vehicleId}/loaded-zone-set/enabledEnable/disable individual zones in the loaded setGET/v1/vehicles/{vehicleId}/zone-setsList all zone sets on the vehicleGET/v1/vehicles/{vehicleId}/zone-sets/{name}Read a named zone set in fullPOST/v1/vehicles/{vehicleId}/zone-sets/{name}Create a zone setPUT/v1/vehicles/{vehicleId}/zone-sets/{name}Update an existing zone setDELETE/v1/vehicles/{vehicleId}/zone-sets/{name}Delete a named zone setPOST/v1/vehicles/{vehicleId}/zone-sets/{name}/loadLoad a zone set for navigation