v1.0¶
April 25, 2025¶
Release: Bear Cloud API v1.0¶
Minimum Robot Software Versions¶
- Servi: 24.04.1
- Carti: 24.03.1
Key Features¶
Mission Type Messages¶
Introduces mission types as first-class message types to create and send missions. This provides a clear distinction between mission types compatible with different robot families. Example: TraverseMission is only applicable to Carti robots.
Unified Map Data Retrieval¶
Consolidates map-related data access into a single endpoint to retrieve relevant map annotation dats, simplifying automated navigation and mission commands.
Multi-Robot Subscription Support¶
Enables selection of multiple robots via RobotSelector in subscription endpoints, allowing monitoring of all robots in a location with a single API call per endpoint.
Improved Error Handling¶
Enhances error messaging and diagnostics for better overall API usability.
New API Customers¶
Please contact your Account Manager to discuss API use cases and request API keys.
Impact on Beta Customers¶
Bear Cloud API v1.0 is not backward compatible with Beta v0.1. Current Beta users must download and compile the new v1.0 Protobuf library. Refer to the functional comparison table below and follow the Upgrade Guide. Contact Customer Support or your Account Manager if additional help is needed.
How to Upgrade¶
- Review the v1.0 API endpoint specification.
- Upgrade robot software to the compatible versions listed above.
- Download and compile the new v1.0 Protobuf library. See our Programming Guide and examples for relevant endpoints. 4 . Test your integration against the new version.
Note
Our robot software supports backward compatibility, allowing switching between v0 and v1 for a stable migration.
API Functionality Comparison: Beta v0.1 vs. Prod v1.0¶
| v0.1 Beta | v1.0 Prod | What’s Changed |
|---|---|---|
| CreateMission | CreateMission | Mission behavior now indicated by message type, e.g. TraverseMissionand BussingMission |
| UpdateMission | UpdateMission | Same as above, follows the mission type model |
| SubscribeMissionStatus | SubscribeMissionStatus | v0.1 supports only one robot_id; v1.0 supports RobotSelector for multi-robot monitoring |
| GetCurrentMapContent GetMap GetMapAnnotation GetMapData |
GetCurrentMap | v0.1 requires chaining multiple endpoints; v1.0 consolidates into a single call |
| SubscribeTrayStatuses | SubscribeTrayStatuses | v0.1 lacks tray names; v1.0 returns map keyed by tray name, supports RobotSelector |
| SubscribeRobotPose | SubscribeRobotPose | v0.1 supports single-robot pose tracking; v1.0 supports multi-robot with RobotSelector |
| ChargeRobot | ChargeRobot | Same functionality; updated to new Protobuf library |
| LocalizeRobot | LocalizeRobot | Same functionality; updated to new Protobuf library |
| SubscribeLocalizationStatus | SubscribeLocalizationStatus | Same functionality; updated to new Protobuf library |
| AppendMission | AppendMission | Same functionality; updated to new Protobuf library |
| SubscribeRobotStatus | SubscribeRobotStatus | Same functionality; updated to new Protobuf library |
| SubscribeBatteryStatus | SubscribeBatteryStatus | Same functionality; updated to new Protobuf library |
| GetLocation | n/a | Not available in v1.0; may return in a future version |
| SwitchMap | n/a | Not available in v1.0; may return in a future version |
| SetRobotPose | n/a | Not available in v1.0; may return in a future version |
| GetRobotSystemInfo | n/a | Not available in v1.0; may return in a future version |