Skip to content

Robot's map filter image

A PGM mask of a filter the robot applies on its currently assigned map. Same dimensions as the map image.

POST/api/robot/getMapFilterImage

Authorizations

x-auth-apikeystringheaderrequired

Your Rhombus API key. Must be accompanied by the x-auth-scheme header set to api-token (or partner-api-token for partner endpoints).

Headers

x-auth-schemeenum<string>headerrequireddefault: api-token

Authentication scheme identifier. Use api-token for standard API key authentication, partner-api-token for partner API key authentication. Must be paired with the x-auth-apikey header containing your API key.

Available options: api-token, api, partner-api-token, partner-api

Body

application/json · object

Request for the mask image of a map filter the robot applies.

deviceUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

mapFilterUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

Response

200 OK

*/* · file

image/x-portable-graymap · file