Postman collection for Bear Robotics Public REST API v1.3. This collection includes all unary (non-streaming) endpoints defined in the BearAPI v1.3 service.
\nAPI Version: v1.3
\nEndpoints: 23 endpoints (7 endpoints from v1.0 + 11 additional endpoints in v1.1 + 2 additional endpoints in v1.2 + 3 additional endpoints in v1.3)
\nBear Cloud API v1.3 is designed to be backward compatible with v1.2, v1.1, and v1.0. However, some endpoints require specific robot software versions (Servi 26.02, Carti 26.02, AMR 26.02 for full support).
\nNew Endpoints (3):
\nCreateMissionBatch - Atomically create multiple missions in a single request
AppendMissionBatch - Atomically append multiple missions to the end of the mission queue
ClearMissionStatus - Clear the robot's mission status
Updated Endpoints:
\nGetRobotStatus - Added navigation_state field (carries the robot's stuck state)
GetMap - Added md5_checksum field in MapImageFileInfo for integrity verification (CRC32C checksum is deprecated)
Streaming RPCs (not included in this collection): SubscribeNavigationStatus, SubscribeOnlineStatus, and the now fleet-capable SubscribeEmergencyStopStatus are streaming endpoints and are documented in the API reference rather than this REST collection.
This collection provides a comprehensive set of endpoints for interacting with Bear Robotics robots via REST API v1.3. It covers:
\nMission Commands: Create, append, update, and manage robot missions (includes v1.3 additions: CreateMissionBatch, AppendMissionBatch, ClearMissionStatus)
\nMaps & Locations: Retrieve maps, locations, and destination information
\nLocalization & Navigation: Control robot positioning and navigation
\nRobot Status: Monitor robot connectivity and operational states (includes v1.3 addition: navigation_state on GetRobotStatus)
\nRobot System: System information and OS-level commands
\nFleet Management: Manage multiple robots and locations
\nServi-Specific Extensions: Tray calibration for Servi robots
\nCarti-Specific Extensions: Conveyor control for Carti robots
\nv1.0 endpoints (7 endpoints):
\n/v1/mission/append - AppendMission
/v1/mission/create - CreateMission
/v1/mission/update - UpdateMission
/v1/robot/charge - ChargeRobot
/v1/current-map/get - GetCurrentMap
/v1/robot/localize - LocalizeRobot
/v1/robot-ids/list - ListRobotIDs
v1.1 additional endpoints (11 endpoints):
\n/v1/location-info/get - GetLocationInfo
/v1/map/get - GetMap
/v1/map/switch - SwitchMap
/v1/pose/set - SetPose
/v1/robot-state/get - GetRobotStatus
/v0/robot-system-info/get - GetRobotSystemInfo
/v1/system-command/run - RunSystemCommand
/v1/available-locations/get - GetAvailableLocations
/v1/trays/calibrate - CalibrateTrays
/v1/conveyor-index/get - GetConveyorIndex
/v1/conveyor/control - ControlConveyor
v1.2 additional endpoints (2 endpoints):
\n/v1/mission-workflow/create - CreateMissionWorkflow
/v1/goal/skip - SkipGoal
v1.3 additional endpoints (3 endpoints):
\n/v1/mission/create-batch - CreateMissionBatch
/v1/mission/append-batch - AppendMissionBatch
/v1/mission-status/clear - ClearMissionStatus
Required Collection Variables:
\nbase_url: API Base URL (e.g., https://api.bearrobotics.ai)
auth_url: Authentication server URL (e.g., https://api-auth.bearrobotics.ai)
robot_id: Robot ID to use for API requests
Authentication Variables:
\napi_key, api_secret, scopeSet the required Collection Variables in the Collection Variables tab
\nCall the authentication endpoint to obtain a JWT token (token is automatically saved to bearer_token)
Use the bearer_token in subsequent API requests
For detailed API documentation, refer to the Bear Robotics API documentation:
\nGet JWT token using API Key and Secret.
\nThe api_key, secret, and scope are all issued together with your Bear Robotics credentials JSON file. Use the exact values provided to you — scope is a fixed value tied to your credentials and is not a literal like \"Bear\".
{\n \"api_key\": \"your-api-key\",\n \"secret\": \"your-api-secret\",\n \"scope\": \"your-scope\"\n}\n\n{\n \"token\": \"eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...\"\n}\n\nNote: The token will be automatically saved to the bearer_token collection variable upon successful response.
The API key, secret, and scope are submitted to the authentication server
\nThe server validates the credentials
\nA JWT token is returned upon successful authentication
\nTokens typically expire after 1 hour. Cache and reuse the token across requests; refresh it periodically (e.g., every 30 minutes) rather than requesting a new token per API call.
\nFor 401 errors:
\nVerify api_key and api_secret are correctly set in Collection Variables
Ensure the scope matches the value issued with your API key (it is a fixed credential value, not a literal like \"Bear\")
Confirm your API key and secret are correct
\nVerify the auth_url is correct (https://api-auth.bearrobotics.ai)
\nCheck the Postman Console (View > Show Postman Console) for detailed error messages
\nAuthentication endpoints for obtaining JWT tokens.
\nAPI Key/Secret: Use api_key and secret to obtain JWT tokens for Bear Robotics Public REST API.
api_key, api_secret, scope, auth_url) in the Collection Variables tab before using the authentication endpointbearer_token variable after successful authenticationThe API key, secret, and scope are submitted to the authentication server. The server validates the credentials. A JWT token is returned upon successful authentication.
\n","_postman_id":"2c8b9b98-e0e2-4c21-885f-2efaa93add7c","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"8e12a638-445e-4a8d-ba11-23d9544d65ec","id":"8e12a638-445e-4a8d-ba11-23d9544d65ec","name":"Bear Robotics Public REST API v1.3","type":"collection"}}},{"name":"Mission","item":[{"name":"AppendMission","id":"08bf2176-2386-457f-8394-d682e9787840","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer ","description":"Bearer token for authentication
\n"}],"body":{"mode":"raw","raw":"{\n \"robotId\": \"\",\n \"mission\": {\n \"baseMission\": {\n \"navigateMission\": {\n \"goal\": {\n \"destinationId\": \"dest-123\"\n }\n }\n }\n }\n}"},"url":"/v1/mission/append","description":"Appends a mission to the end of the mission queue.
\nUse this when a mission is currently running; otherwise, prefer CreateMission. Missions are executed in the order they are appended.
\nstring requiredThe ID of the robot that will receive this command.
\nMission requiredUniversal wrapper for mission types. Only one mission type may be set at a time.
\n{\n \"robotId\": \"pennybot-abc123\",\n \"mission\": {\n \"baseMission\": {\n \"navigateMission\": {\n \"goal\": {\n \"destinationId\": \"dest-123\"\n }\n }\n }\n }\n}\nstringThe ID of the mission created.
\n{\n \"missionId\": \"cbd47ab1-df21-479e-9f72-677b81ab55b0\"\n}\nBearer token for authentication
\n"}],"body":{"mode":"raw","raw":"{\n \"robotId\": \"\",\n \"missions\": [\n {\n \"baseMission\": {\n \"navigateMission\": {\n \"goal\": {\n \"destinationId\": \"table-1\"\n }\n }\n }\n },\n {\n \"baseMission\": {\n \"navigateMission\": {\n \"goal\": {\n \"destinationId\": \"table-2\"\n }\n }\n }\n }\n ]\n}"},"url":"/v1/mission/append-batch","description":"Atomically appends multiple missions to the end of the mission queue.
\nAll missions are appended contiguously in the request order. Missions can be appended even when other missions are already queued.
\nNote: This call is atomic — if any mission in the batch fails validation or append, no missions are appended.
\nstring requiredThe ID of the robot that will receive this command.
\nrepeated Mission requiredThe list of missions to append, in execution order. Each entry is the same Mission wrapper used by CreateMission. Only one mission type may be set per entry.
{\n \"robotId\": \"pennybot-abc123\",\n \"missions\": [\n {\n \"baseMission\": {\n \"navigateMission\": {\n \"goal\": {\n \"destinationId\": \"table-1\"\n }\n }\n }\n },\n {\n \"baseMission\": {\n \"navigateMission\": {\n \"goal\": {\n \"destinationId\": \"table-2\"\n }\n }\n }\n }\n ]\n}\nrepeated stringThe IDs of the missions appended, in the same order as the request.
\n{\n \"missionIds\": [\n \"f842c8ac-62de-412e-90fb-bf37022db2f4\",\n \"a1b2c3d4-5e6f-7890-abcd-ef1234567890\"\n ]\n}\nCreate a mission to go charge a robot regardless of battery state.
\nChargeRobot is a special type of mission. Use this command to instruct the robot to begin charging, regardless of its current battery level. This command is only supported on robots equipped with a contact-based charging dock.
You can use SubscribeBatteryStatus to monitor the charging process.
\nstring requiredThe ID of the robot that will receive this command.
\n{\n \"robotId\": \"pennybot-abc123\"\n}\nstringThe ID of the mission created. Since this command is a special type of mission, its execution state is also available in response messages from SubscribeMissionStatus.
\n{\n \"missionId\": \"mission-xyz-001\"\n}\nSend a robot on a mission of specified type.
\nstring requiredThe ID of the robot that will receive this command.
\nMission requiredUniversal wrapper for mission types. Only one mission type may be set at a time.
\n{\n \"robotId\": \"pennybot-abc123\",\n \"mission\": {\n \"baseMission\": {\n \"navigateMission\": {\n \"goal\": {\n \"destinationId\": \"dest-123\"\n }\n }\n }\n }\n}\nstringThe ID of the mission created.
\n{\n \"missionId\": \"cbd47ab1-df21-479e-9f72-677b81ab55b0\"\n}\nBearer token for authentication
\n"}],"body":{"mode":"raw","raw":"{\n \"robotId\": \"\",\n \"missions\": [\n {\n \"baseMission\": {\n \"navigateMission\": {\n \"goal\": {\n \"destinationId\": \"pickup_zone\"\n }\n }\n }\n },\n {\n \"baseMission\": {\n \"navigateMission\": {\n \"goal\": {\n \"destinationId\": \"drop_zone\"\n }\n }\n }\n }\n ]\n}"},"url":"/v1/mission/create-batch","description":"Atomically creates multiple missions in a single request.
\nThe created missions are queued contiguously in the order they appear in the request, and the returned mission IDs match that order.
\nNote: This call is atomic — if any mission in the batch fails validation or creation, no missions are created.
\nstring requiredThe ID of the robot that will receive this command.
\nrepeated Mission requiredThe list of missions to create, in execution order. Each entry is the same Mission wrapper used by CreateMission. Only one mission type may be set per entry.
{\n \"robotId\": \"pennybot-abc123\",\n \"missions\": [\n {\n \"baseMission\": {\n \"navigateMission\": {\n \"goal\": {\n \"destinationId\": \"pickup_zone\"\n }\n }\n }\n },\n {\n \"baseMission\": {\n \"navigateMission\": {\n \"goal\": {\n \"destinationId\": \"drop_zone\"\n }\n }\n }\n }\n ]\n}\nrepeated stringThe IDs of the missions created, in the same order as the request.
\n{\n \"missionIds\": [\n \"cbd47ab1-df21-479e-9f72-677b81ab55b0\",\n \"d6637a14-5f6b-43f6-bd86-cc1871a8322e\"\n ]\n}\nIssues a command to control or update the current mission (e.g., pause, cancel).
\nWe currently do not support updating missions in mission queue. Attempting to send UpdateMission command to a queued mission will result in NOT_FOUND error.
string requiredThe ID of the robot that will receive this command.
\nMissionCommand requiredCommand to update the state of an active mission.
\nenum{\n \"robotId\": \"pennybot-abc123\",\n \"missionCommand\": {\n \"missionId\": \"f842c8ac-62de-412e-90fb-bf37022db2f4\",\n \"command\": \"COMMAND_PAUSE\"\n }\n}\n(No fields defined)
\n{}\nBearer token for authentication
\n"}],"body":{"mode":"raw","raw":"{\n \"robotId\": \"\",\n \"missionWorkflow\": {\n \"serviWorkflow\": {\n \"delivery\": {\n \"goals\": [\n {\n \"destinationId\": \"table-1\"\n },\n {\n \"destinationId\": \"table-2\"\n }\n ]\n }\n }\n }\n}"},"url":"/v1/mission-workflow/create","description":"Creates a new mission workflow that mirrors touchscreen presets, including automatic return point selection.
\nThis call will fail if:
\nReturns the list of mission_ids for the created missions if successful.
\nstring requiredThe ID of the robot that will receive this command.
\nMissionWorkflow requiredWorkflows mirror touchscreen behavior and presets (including automatic return selection).
\n{\n \"robotId\": \"pennybot-abc123\",\n \"missionWorkflow\": {\n \"serviWorkflow\": {\n \"delivery\": {\n \"goals\": [\n {\n \"destinationId\": \"table-1\"\n },\n {\n \"destinationId\": \"table-2\"\n }\n ]\n }\n }\n }\n}\n{\n \"robotId\": \"carti-001\",\n \"missionWorkflow\": {\n \"cartiWorkflow\": {\n \"traverse\": {\n \"goals\": [\n {\n \"destinationId\": \"room-a\"\n },\n {\n \"pose\": {\n \"xMeters\": 5.2,\n \"yMeters\": 3.1,\n \"headingRadians\": 1.57\n }\n }\n ]\n }\n }\n }\n}\nrepeated stringList of mission IDs for the created missions.
\n{\n \"missionIds\": [\n \"mission-001\",\n \"mission-002\"\n ]\n}\nBearer token for authentication
\n"}],"body":{"mode":"raw","raw":"{\n \"robotId\": \"\"\n}"},"url":"/v1/goal/skip","description":"Moves to the next destination in the current mission.
\nThis call will fail if:
\nReturns the mission_id of the current mission where the goal was skipped.
\nstring requiredThe ID of the robot that will skip the current goal.
\n{\n \"robotId\": \"pennybot-abc123\"\n}\nstringThe unique identifier of the mission where the goal was skipped.
\n{\n \"missionId\": \"mission-xyz-001\"\n}\nBearer token for authentication
\n"}],"body":{"mode":"raw","raw":"{\n \"robotId\": \"\"\n}"},"url":"/v1/mission-status/clear","description":"Clears the robot's mission status, removing the missions reported by SubscribeMissionStatus.
\nUse this to reset the mission queue once all missions have reached a terminal state.
\nWarning: This call will fail if the robot is on a running or paused mission. Cancel or finish the active mission before clearing.
\nstring requiredThe ID of the robot whose mission status will be cleared.
\n{\n \"robotId\": \"pennybot-abc123\"\n}\nrepeated stringThe unique identifiers of the cleared missions.
\n{\n \"missionIds\": [\n \"f842c8ac-62de-412e-90fb-bf37022db2f4\",\n \"d6637a14-5f6b-43f6-bd86-cc1871a8322e\"\n ]\n}\nBasic mission-related operations (includes v1.3 additions: CreateMissionBatch, AppendMissionBatch, ClearMissionStatus)
\n","_postman_id":"049407f3-9e6f-4f93-bf66-4db070a651e7","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"8e12a638-445e-4a8d-ba11-23d9544d65ec","id":"8e12a638-445e-4a8d-ba11-23d9544d65ec","name":"Bear Robotics Public REST API v1.3","type":"collection"}}},{"name":"Locations & Map","item":[{"name":"GetCurrentMap","id":"5b85d832-9b00-43c6-8c0e-82633e7b55f6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"robotId\": \"\"\n}"},"url":"/v1/current-map/get","description":"Retrieves the current map used by the robot.
\nThe returned map includes annotations and destinations, which can be used in mission destination, localization goals, and navigation.
\nstring requiredThe robot ID used to request the map currently loaded on the robot.
\n{\n \"robotId\": \"pennybot-abc123\"\n}\nMapMap represents a navigable map used by robots, including metadata and associated annotations.
\n{\n \"map\": {\n \"mapId\": \"map-01\",\n \"createdTime\": \"2025-03-28T12:00:00Z\",\n \"modifiedTime\": \"2025-04-01T09:45:00Z\",\n \"displayName\": \"Main Floor Map\",\n \"annotation\": {\n \"annotationId\": \"annot-123\",\n \"displayName\": \"Service Area Zones\",\n \"createdTime\": \"2025-03-30T10:15:00Z\",\n \"destinations\": {\n \"Loading Dock 1\": {\n \"destinationId\": \"Loading Dock 1\",\n \"displayName\": \"Loading Dock 1\"\n }\n }\n }\n }\n}\nNote: This API communicates directly with the robot. image_url may be empty, as the robot does not serve rendered images.
\nBearer token for authentication
\n"}],"body":{"mode":"raw","raw":"{\n \"locationId\": \"\"\n}"},"url":"/v1/location-info/get","description":"Retrieves information about a specific location by its ID.
\nThe location includes metadata such as floors, sections, and their associated maps.
\nNote: This does not require robot connectivity.
\nstring requiredThe location_id is a 4 character alphanumeric identifier for the location. e.g., \"3R0A\"
\n{\n \"locationId\": \"3R0A\"\n}\nLocationLocation represents a physical space where robots operate, containing floors, sections, and maps.
\n{\n \"location\": {\n \"locationId\": \"3R0A\",\n \"createdTime\": \"2025-03-28T12:00:00Z\",\n \"modifiedTime\": \"2025-04-01T09:45:00Z\",\n \"displayName\": \"Main Office Building\",\n \"floors\": {\n \"0\": {\n \"displayName\": \"Ground Floor\",\n \"sections\": [\n {\n \"displayName\": \"Lobby Area\",\n \"currentMapId\": \"map-lobby-001\"\n }\n ]\n }\n }\n }\n}\nBearer token for authentication
\n"}],"body":{"mode":"raw","raw":"{\n \"mapId\": \"\"\n}"},"url":"/v1/map/get","description":"Retrieves a saved map by map_id from the cloud.
\nUse this to fetch a stored map from the cloud database.
\nNote: This does not require robot connectivity.
\nstring requiredThe unique identifier of the map to retrieve.
\n{\n \"mapId\": \"map-001\"\n}\nMapMap represents a navigable map used by robots, including metadata and associated annotations.
\nContains metadata about the map image file for integrity verification (nested under image_download_info.file_info).
{\n \"map\": {\n \"mapId\": \"map-001\",\n \"createdTime\": \"2025-03-28T12:00:00Z\",\n \"modifiedTime\": \"2025-04-01T09:45:00Z\",\n \"displayName\": \"Office Floor Plan\",\n \"annotation\": {\n \"annotationId\": \"annot-001\",\n \"displayName\": \"Office Zones\",\n \"destinations\": {}\n },\n \"imageDownloadInfo\": {\n \"fileInfo\": {\n \"checksum\": 1234567890,\n \"size\": 2048576,\n \"md5Checksum\": \"9e107d9d372bb6826bd81d3542a419d6\"\n },\n \"downloadUrl\": {\n \"url\": \"https://storage.googleapis.com/maps/map-001.png?signature=...\",\n \"expiresAt\": \"2025-04-01T12:00:00Z\"\n }\n },\n \"origin\": {\n \"xM\": 0.0,\n \"yM\": 0.0,\n \"yawRadians\": 0.0\n },\n \"resolution\": 0.05\n }\n}\nBearer token for authentication
\n"}],"body":{"mode":"raw","raw":"{\n \"robotId\": \"\",\n \"mapSelector\": {\n \"floorLevel\": 1,\n \"sectionIndex\": 0\n }\n}"},"url":"/v1/map/switch","description":"Switch the robot's current map to a specified map.
\nThe request must specify the floor level and section index of the desired map.
\nstring requiredThe ID of the robot that will switch maps.
\nMapSelector requiredSpecifies which map to switch to.
\n{\n \"robotId\": \"pennybot-abc123\",\n \"mapSelector\": {\n \"floorLevel\": 1,\n \"sectionIndex\": 0\n }\n}\nstringThe ID of the new map that the robot is now using.
\n{\n \"mapId\": \"map-lobby-001\"\n}\nOperations for fetching and setting location and map settings
\n","_postman_id":"ddf05ea2-4af6-4c42-bbad-056272ab91e0","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"8e12a638-445e-4a8d-ba11-23d9544d65ec","id":"8e12a638-445e-4a8d-ba11-23d9544d65ec","name":"Bear Robotics Public REST API v1.3","type":"collection"}}},{"name":"Localization & Navigation","item":[{"name":"LocalizeRobot","id":"829a65b6-966a-47bc-b61b-dcdfbb4861d9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"robotId\": \"\",\n \"goal\": {\n \"destinationId\": \"dest-123\"\n }\n}"},"url":"/v1/robot/localize","description":"Localizes the robot to a known pose or destination.
\nIf the request is accepted, subscribe to SubscribeLocalizationStatus to track localization progress.
\nstring requiredThe ID of the robot that the localization command is sent to.
\nGoal requiredGoal represents a target destination or pose for the robot to localize to.
\n{\n \"robotId\": \"pennybot-abc123\",\n \"goal\": {\n \"destinationId\": \"dest-123\"\n }\n}\nor
\n{\n \"robotId\": \"pennybot-abc123\",\n \"goal\": {\n \"pose\": {\n \"xMeters\": 2.5,\n \"yMeters\": 1.8,\n \"headingRadians\": 1.57\n }\n }\n}\n(No fields defined)
\n{}\nBearer token for authentication
\n"}],"body":{"mode":"raw","raw":"{\n \"robotId\": \"\",\n \"pose\": {\n \"xMeters\": 2.5,\n \"yMeters\": 1.8,\n \"headingRadians\": 1.57\n }\n}"},"url":"/v1/pose/set","description":"Sets the robot's current pose to a specified position and orientation.
\nUnlike LocalizeRobot, the robot will not attempt to verify whether the pose that is set aligns with its camera view.
\nstring requiredThe ID of the robot to set the pose for.
\nPose requiredThe new pose for the robot.
\n{\n \"robotId\": \"pennybot-abc123\",\n \"pose\": {\n \"xMeters\": 2.5,\n \"yMeters\": 3.0,\n \"headingRadians\": 1.57\n }\n}\n(No fields defined)
\n{}\nLow-level endpoints for robot pose and localization
\n","_postman_id":"2a429061-565c-48bf-b705-02691527e03b","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"8e12a638-445e-4a8d-ba11-23d9544d65ec","id":"8e12a638-445e-4a8d-ba11-23d9544d65ec","name":"Bear Robotics Public REST API v1.3","type":"collection"}}},{"name":"Robot Status","item":[{"name":"GetRobotStatus","id":"eab10a4c-62c1-45f9-97a7-293b1facce36","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"robotId\": \"\"\n}"},"url":"/v1/robot-state/get","description":"Get the latest robot state.
\nRobot state includes connectivity and operational states.
\nstring requiredThe ID of the robot to get status for.
\n{\n \"robotId\": \"pennybot-abc123\"\n}\nRobotStateThe current robot state including connectivity, battery, emergency stop, mission, pose, error information, velocity, navigation state, and type-specific states.
\noneof(v1.3)Represents navigation-related state for the robot.
\n(v1.3)Whether the robot is currently unable to make navigation progress, and the reason for it when known. \"Stuck\" is a transient, recoverable navigation condition (e.g., obstruction, restricted area), distinct from a mission failure.
\nenumenum{\n \"robotState\": {\n \"connection\": {\n \"state\": \"STATE_CONNECTED\"\n },\n \"battery\": {\n \"chargePercent\": 85,\n \"state\": \"STATE_CHARGING\",\n \"chargeMethod\": \"CHARGE_METHOD_CONTACT\"\n },\n \"emergencyStop\": {\n \"emergency\": \"EMERGENCY_DISENGAGED\",\n \"buttonPressed\": \"EMERGENCY_DISENGAGED\"\n },\n \"mission\": {\n \"missionId\": \"mission-123\",\n \"state\": \"STATE_RUNNING\"\n },\n \"pose\": {\n \"xMeters\": 1.5,\n \"yMeters\": 2.8,\n \"headingRadians\": 0.78\n },\n \"errorCodes\": {\n \"codes\": [\"E001\", \"E042\"]\n },\n \"twist\": {\n \"linearVelocity\": 0.5,\n \"angularVelocity\": 0.1\n },\n \"navigationState\": {\n \"stuckState\": {\n \"state\": \"STATE_NOT_STUCK\",\n \"reason\": \"REASON_UNKNOWN\"\n }\n },\n \"serviState\": {\n \"trayStates\": {}\n }\n }\n}\nQueries for real-time robot status data (includes v1.3 addition: navigation_state on GetRobotStatus)
\n","_postman_id":"35603a71-fefb-4b35-a162-2500d1b17d84","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"8e12a638-445e-4a8d-ba11-23d9544d65ec","id":"8e12a638-445e-4a8d-ba11-23d9544d65ec","name":"Bear Robotics Public REST API v1.3","type":"collection"}}},{"name":"Robot System","item":[{"name":"GetRobotSystemInfo","id":"e32fa697-b65c-41d8-919f-f6f0bf8a793a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"robotId\": \"\"\n}"},"url":"/v0/robot-system-info/get","description":"Get the overall robot system information, including software version, robot family, robot ID, and display name.
\nThe system info tends to be static and does not change often.
\nstring requiredThe ID of the robot to retrieve system information for.
\n{\n \"robotId\": \"pennybot-abc123\"\n}\nSystemInfoContains system-level information about the robot.
\n{\n \"systemInfo\": {\n \"softwareVersion\": \"servi-24.03\",\n \"robotFamily\": \"ROBOT_FAMILY_SERVI_PLUS\",\n \"robotId\": \"pennybot-abc123\",\n \"displayName\": \"Main Kitchen\"\n }\n}\nExecute a OS-level command on a robot.
\nNote: When rebooting or shutting down the robot, a response will return immediately to acknowledge the request but may take several minutes before the robot reconnects (for reboot) or powers off (for shutdown).
\nstring requiredThe ID of the robot that will receive this command.
\nSystemCommand requiredThe system command to execute on the robot.
\nenumEmpty message. Pass an empty object {} to initiate a shutdown.
{\n \"robotId\": \"pennybot-abc123\",\n \"systemCommand\": {\n \"reboot\": {\n \"type\": \"TYPE_SOFTWARE_ONLY\"\n }\n }\n}\n{\n \"robotId\": \"pennybot-abc123\",\n \"systemCommand\": {\n \"shutdown\": {}\n }\n}\n(No fields defined)
\n{}\nSystem-level operations and Queries for static robot configurations
\n","_postman_id":"d436a09a-b905-42d0-adbd-800d5441e900","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"8e12a638-445e-4a8d-ba11-23d9544d65ec","id":"8e12a638-445e-4a8d-ba11-23d9544d65ec","name":"Bear Robotics Public REST API v1.3","type":"collection"}}},{"name":"Fleet Management","item":[{"name":"ListRobotIDs","id":"48d09f0a-4d3a-4a3e-96e9-071b25f11287","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"filter\": {\n \"locationId\": \"\"\n }\n}"},"url":"/v1/robot-ids/list","description":"Retrieves a list of robot IDs the user has access to, filtered by optional criteria.
\nThe list includes all known robots, regardless of their current connection state.
\nRobotFilter requiredRobotFilter defines the conditions for selecting robots. All specified fields are combined using an AND condition.
{\n \"filter\": {\n \"locationId\": \"1D9X\"\n }\n}\nA response message has 2 fields:
\n{\n \"totalRobots\": 5,\n \"robotIds\": [\n \"pennybot-abc123\",\n \"pennybot-def456\",\n \"pennybot-ghi789\",\n \"pennybot-jkl012\",\n \"pennybot-mno345\"\n ]\n}\nBearer token for authentication
\n"}],"body":{"mode":"raw","raw":"{}"},"url":"/v1/available-locations/get","description":"Returns a map of locations the user has access to.
\nThe map consists of the location ID (key) paired with its human-readable name (value).
\n(No fields required)
\n{}\nmap<string, string>A mapping of location ID (key) with its corresponding, human-readable location name. e.g. { \"1D9X\": \"785_Platform\" }
\n{\n \"locations\": {\n \"1D9X\": \"785_Platform\",\n \"3R0A\": \"Main Office Building\",\n \"5K2B\": \"Warehouse Facility\"\n }\n}\nFleet-level operations
\n","_postman_id":"07ba2d1f-e107-41af-bd3d-3a47c1d8d407","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"8e12a638-445e-4a8d-ba11-23d9544d65ec","id":"8e12a638-445e-4a8d-ba11-23d9544d65ec","name":"Bear Robotics Public REST API v1.3","type":"collection"}}},{"name":"Servi","item":[{"name":"CreateMission","id":"abf17b52-ebf9-4658-b3e6-1b1617b1dbe2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"robotId\": \"\",\n \"mission\": {\n \"serviMission\": {\n \"navigateMission\": {\n \"goal\": {\n \"destinationId\": \"dest-123\"\n }\n }\n }\n }\n}"},"url":"/v1/mission/create","description":"Use the shared CreateMission endpoint to send missions for Servi robots. Servi-specific missions must be sent using the appropriate request message format.
Note: When sending a Servi mission, servi.Feedback and ServiType are returned in SubscribeMissionStatus response message.
string requiredThe ID of the robot that will receive this command.
\nMission requiredUniversal wrapper for mission types. Only one mission type may be set at a time.
\nservi.MissionUse the field servi_mission to create and send a servi mission. Current API version supports 6 types of Servi mission.
{\n \"robotId\": \"pennybot-456efg\",\n \"mission\": {\n \"serviMission\": {\n \"navigateMission\": {\n \"goal\": {\n \"destinationId\": \"dest-123\"\n }\n }\n }\n }\n}\n\nstringThe ID of the mission created.
\n{\n \"missionId\": \"cbd47ab1-df21-479e-9f72-677b81ab55b0\"\n}\n\nBearer token for authentication
\n"}],"body":{"mode":"raw","raw":"{\n \"robotId\": \"\",\n \"selector\": {\n \"trayNames\": [\"top\", \"middle\"]\n }\n}"},"url":"/v1/trays/calibrate","description":"Calibrates the trays on the robot.
\nOnly applicable for tray-equipped robots (e.g., Servi, Servi Plus).
\nCalibrates all trays if no tray names are provided.\nReturns an INVALID_ARGUMENT error and rejects the request if any tray name is invalid.\nReturns an empty response on success.
\nstring requiredThe ID of the robot to calibrate trays on.
\nservi.TraySelector requiredSelector to specify which trays to calibrate.
\n{\n \"robotId\": \"pennybot-456efg\",\n \"selector\": {\n \"trayNames\": [\"top\", \"middle\"]\n }\n}\n(No fields defined)
\n{}\nServi-specific operations
\n","_postman_id":"0bce91ae-2893-4de9-8cf0-4317a8177cdd","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"8e12a638-445e-4a8d-ba11-23d9544d65ec","id":"8e12a638-445e-4a8d-ba11-23d9544d65ec","name":"Bear Robotics Public REST API v1.3","type":"collection"}}},{"name":"Carti","item":[{"name":"CreateMission","id":"85f03bc0-82f9-44c0-9471-ead8878bf056","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"robotId\": \"\",\n \"mission\": {\n \"cartiMission\": {\n \"traverseMission\": {\n \"goals\": [\n {\n \"destinationId\": \"room-a\"\n },\n {\n \"pose\": {\n \"xMeters\": 5.2,\n \"yMeters\": 3.1,\n \"headingRadians\": 1.57\n }\n }\n ],\n \"params\": {}\n }\n }\n }\n}"},"url":"/v1/mission/create","description":"Use the shared CreateMission endpoint to send missions for Carti robots. Carti-specific missions must be sent using the appropriate request message format.
Note: When sending a Carti mission, carti.Feedback and CartiType are returned in SubscribeMissionStatus response message.
string requiredThe ID of the robot that will receive this command.
\nMission requiredUniversal wrapper for mission types. Only one mission type may be set at a time.
\ncarti.MissionUse the field carti_mission to create and send a mission. Current API version supports 4 types of Carti missions.
{\n \"robotId\": \"carti-001\",\n \"mission\": {\n \"cartiMission\": {\n \"traverseMission\": {\n \"goals\": [\n {\n \"destinationId\": \"room-a\"\n },\n {\n \"pose\": {\n \"xMeters\": 5.2,\n \"yMeters\": 3.1,\n \"headingRadians\": 1.57\n }\n }\n ],\n \"params\": {}\n }\n }\n }\n}\nstringThe ID of the mission created.
\n{\n \"missionId\": \"mission-abc123\"\n}\nBearer token for authentication
\n"}],"body":{"mode":"raw","raw":"{\n \"robotId\": \"\"\n}"},"url":"/v1/conveyor-index/get","description":"Retrieves the configured conveyor indexes for the robot.
\nIndexes represent logical positions, not physical installation:
\nstring requiredThe ID of the robot.
\n{\n \"robotId\": \"\"\n}\nrepeated int32List of conveyor indexes.
\nBearer token for authentication
\n"}],"body":{"mode":"raw","raw":"{\n \"robotId\": \"\",\n \"commands\": [\n {\n \"index\": 1,\n \"command\": \"COMMAND_CONVEYOR_MOTOR_STOP\"\n }\n ]\n}"},"url":"/v1/conveyor/control","description":"Controls conveyor motor operations for the specified conveyor indexes.
\nThis call allows manual control of conveyor motors for clockwise/counter-clockwise rotation or stop commands.
\nNote: These endpoints are only available for Carti robot family. Attempting to run conveyor commands on a non-Carti robot will result in an INVALID_ARGUMENT error.
\nstring requiredThe ID of the robot that will receive this command.
\nrepeated carti.ConveyorMotorCommand requiredList of conveyor motor commands to execute.
\nenum{\n \"robotId\": \"carti-001\",\n \"commands\": [\n {\n \"index\": 1,\n \"command\": \"COMMAND_CONVEYOR_MOTOR_CW\"\n },\n {\n \"index\": 2,\n \"command\": \"COMMAND_CONVEYOR_MOTOR_STOP\"\n }\n ]\n}\n(No fields defined)
\n{}\nCarti-specific operations
\n","_postman_id":"7eb962e8-2df6-4c94-832a-021b17d2eb13","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"8e12a638-445e-4a8d-ba11-23d9544d65ec","id":"8e12a638-445e-4a8d-ba11-23d9544d65ec","name":"Bear Robotics Public REST API v1.3","type":"collection"}}}],"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]}},"event":[{"listen":"prerequest","script":{"type":"text/javascript","requests":{},"exec":["// Optional: Auto-refresh token if expired","// Uncomment the following code to enable automatic token refresh","// Note: This requires api_key, api_secret, and scope to be set","","/*","const bearerToken = pm.collectionVariables.get('bearer_token');","const apiKey = pm.collectionVariables.get('api_key');","const apiSecret = pm.collectionVariables.get('api_secret');","const scope = pm.collectionVariables.get('scope');","","// Only auto-refresh if using API key method and token is missing/expired","if (apiKey && apiSecret && (!bearerToken || bearerToken === '')) {"," // Token refresh logic would go here"," // For now, user should manually call the authentication endpoint","}","*/"],"id":"9a1cd3ed-bc1e-4273-a65f-ad710c1c8953"}},{"listen":"test","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"d3f74515-3c12-40d0-aac2-bddf24717dcd"}}],"variable":[{"key":"base_url","value":"","description":"API Base URL (e.g., https://api.bearrobotics.ai for Production)"},{"key":"auth_url","value":"","description":"API Authentication Server URL (e.g., https://api-auth.bearrobotics.ai for Production)"},{"key":"robot_id","value":"","description":"Robot ID to use for API requests (set this once and it will be used across all requests)"},{"key":"location_id","value":"","description":"Location ID to use for location-related requests (e.g., GetLocationInfo)"},{"key":"map_id","value":"","description":"Map ID to use for map-related requests (e.g., GetMap)"},{"key":"bearer_token","value":"","description":"JWT Bearer token (automatically set after authentication, or set manually)"},{"key":"api_key","value":"","description":"API Key for authentication (optional, if using API Key method)"},{"key":"api_secret","value":"","description":"API Secret for authentication (required for API Key method)"},{"key":"scope","value":"","description":"Authentication scope issued with your API key (a fixed credential value, e.g., \"your-scope\")"}]}