---
title: "POST /v1/current-map/get"
method: POST
path: "/v1/current-map/get"
tags: ["Locations & Maps"]
---

# POST /v1/current-map/get

`POST /v1/current-map/get`

## Request

- Base URL: `https://api.bearrobotics.ai`
- URL: `https://api.bearrobotics.ai/v1/current-map/get`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/bearrobotics/apis/bear-cloud-api/docs/v1/current-map/get/post.ts> (a function with typed inputs; its response is checked against the schema)

Retrieves the current map used by the robot.

 The returned map includes annotations and destinations, which can be used
 in mission destination, localization goals, and navigation.

 Note:
 - This API communicates directly with the robot.
 - image_url may be empty, as the robot does not serve rendered images.

## Request body

- object
  - `robotId` string, required

## Response `200`

OK

- GetCurrentMapResponse
  - `map` Map: Map represents a navigable map used by robots, including metadata and associated annotations.
    - `mapId` string: Unique identifier for the map. Example: "9578"
    - `createdTime` string, date-time: Timestamp indicating when the map was created.
    - `modifiedTime` string, date-time: Timestamp indicating the last time the map was modified.
    - `displayName` string: Display name of the map, matching the name used in Bear Universe. Example: "ITCT SEOUL"
    - `annotation` Annotation: Annotation defines a specific area on the map, often used to group destinations or assign special parameters.
      - `annotationId` string: Unique identifier for the annotation. Example: "67305"
      - `displayName` string: Descriptive name for the annotation. Example: "ITCT annotation A"
      - `createdTime` string, date-time: Timestamp indicating when the annotation was created.
      - `destinations` object: A collection of destinations associated with this annotation. Each entry pairs a destination ID (key) with its corresponding Destination message (value).
    - `imageDownloadInfo` MapImageDownloadInfo: MapImageDownloadInfo contains the information needed to download a map image.
      - `fileInfo` MapImageFileInfo: MapImageFileInfo contains metadata about the map image file for integrity verification.
        - `checksum` integer: [Deprecated] CRC32C checksum of the map image file. Use md5Checksum instead.
        - `size` string: Size of the map image file in bytes.
        - `md5Checksum` string: MD5 checksum represented as a 32-character lowercase hexadecimal string.
      - `downloadUrl` SignedURL: SignedURL represents a signed URL for file access with expiration.
        - `url` string
        - `expiresAt` string, date-time
    - `origin` Origin: Origin represents the starting point of the map in terms of its coordinates and orientation.
      - `xM` number, float: X-coordinate of the map origin in meters.
      - `yM` number, float: Y-coordinate of the map origin in meters.
      - `yawRadians` number, float: Orientation (yaw) of the map origin in radians.
    - `resolution` number, float: Resolution of the map in meters per pixel.

## Other responses

- `400`: Bad Request, usually caused by malfored request body.
- `401`: Unauthorized credentials, ensure the JWT is correct and up to date.
- `500`: Internal Server Error
- `503`: Service is temporarily unavailable, which can usually be resolved by backoff retries.
- `504`: Server-side timeout, usually caused by the failure to send/receive commands/responses to the designated robot.

---

[API](https://skmtc.dev/bearrobotics/apis/bear-cloud-api.md) - [All operations](https://skmtc.dev/bearrobotics/apis/bear-cloud-api/llms.txt) - [OpenAPI document](https://skmtc.dev/bearrobotics/apis/bear-cloud-api/revisions/b90843b624b5?raw)