Skip to content

API Conventions

This page defines conventions shared by all Geoportal API endpoints.

  • Base path: https://www.lateral-robotics.com/api/v1
  • Content type: application/json; charset=utf-8
  • Authentication: see Authentication
  • Success responses use 2xx.
  • Response bodies should be well-formed JSON.
  • Timestamps use ISO 8601 UTC.

Error body shape:

Error response body
{
"error": {
"code": number,
"message": string
},
"requestId": string
}
StatusMeaning
400Invalid request
401Not authenticated
403Not authorized
404Not found
409Conflict
429Rate limited
5xxServer error

Example error response:

Error response body
{
"error": {
"code": 400,
"message": "Invalid request"
},
"requestId": "1234567890"
}