Skip to main content

Notes

General guidelines when working with the API

  • For testing, you can replace {robotId} and {streamName} with the actual values of the robot ID and stream name.
  • For methods that modify data (e.g., POST), the request’s body should be detailed in the API documentation, specifying required fields and formats.
  • Status Codes: Utilize HTTP status codes correctly to indicate the outcome of API calls, e.g., 200 OK, 404 Not Found, 400 Bad Request.
  • For testing the API, it is possible to use the following example:
curl -v --location --request GET <route> -H "Authorization: Bearer <token>" --header 'u;'