Retrieves a robot's map metadata given is id

Retrieves an individual map’s metadata or binary data. By default, a map metadata including size, resolution, last updated timestamp and other fields is returned in JSON format (see application/json response). By specifying Accept: image/png the map in binary image form can be retrieved. See also /download API path.

GET /robots/{robotId}/maps/{mapId}

Retrieves a robot's map metadata given is id

cURL

curl --request GET \
  --url https://api.inorbit.ai/robots/{robotId}/maps/{mapId} \
  --header 'x-auth-inorbit-app-key: <api-key>'

200

[
  {
    "robotId": "<string>",
    "mapId": "<string>",
    "frameId": "<string>",
    "label": "<string>",
    "width": 123,
    "height": 123,
    "resolution": 123,
    "x": 123,
    "y": 123,
    "dataHash": "<string>",
    "formatVersion": 123,
    "updatedTs": 123
  }
]

Authorizations

x-auth-inorbit-app-key · string · header · required

InOrbit appKey authenticates API requests using a token.

You can obtain your appKey in the Authentication docs.

Path Parameters

robotId · string · required

The robot's id

mapId · string · required

The map id

Response

200

application/json

A binary map image. Note that response 302 is more frequently implemented.

robotId · string

Unique robot ID

mapId · string

Map ID (unique only within robot)

frameId · string

Frame ID (unique only within robot)

label · string

Map label (usually corresponds to ROS topic)

width · integer

Map width, in pixels

height · integer

Map height, in pixels

resolution · number

Map resolution

x · number

Map origin, X

y · number

Map origin, Y

dataHash · string

Internal data hash. Can be safely used to determine if map has been modified.

formatVersion · number

Map format version. If not provided, it defaults to 1. This field is used to determine the way the map is displayed. Version 2 displays the map as uploaded, while version 1 mirrors the image vertically before displaying it.

updatedTs · number

Latest modification timestamp (unix epoch millis)