Upload map data

This is a multi-part request composed two parts:

• An object which defines the map metadata
• A PNG image of the map

The bottom left corner of the image needs to match the (metadata.x, metadata.y) coordinate of the real world.

POST /robots/{robotId}/maps

Upload map data

cURL

curl --request POST \
  --url https://api.inorbit.ai/robots/{robotId}/maps \
  --header 'Content-Type: multipart/form-data' \
  --header 'x-auth-inorbit-app-key: <api-key>' \
  --form 'metadata={"mapId":"test-map-api","label":"map","frameId":"map","resolution":0.05,"x":0.0,"y":0.0,"formatVersion":2}' \
  --form image='@example-file'

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

Body

multipart/form-data

Multipart request with map metadata and map image.

metadata · string · required

A JSON string containing the map metadata object with the following properties:

• mapId (string, required): The map identifier
• label (string, required): The map label
• frameId (string, optional): The frame identifier
• resolution (number, required): Map resolution
• x (number, required): Map origin X coordinate
• y (number, required): Map origin Y coordinate
• formatVersion (number, optional): Map format version. If not provided, it defaults to 1.

Example:

"{\"mapId\":\"test-map-api\",\"label\":\"map\",\"frameId\":\"map\",\"resolution\":0.05,\"x\":0.0,\"y\":0.0,\"formatVersion\":2}"

image · file · required

Map image in PNG or JPEG format

Response

201

Map saved successfully.