Getting Started
Robot API Documentation
Welcome to the Saha Robotics Robot API documentation. This RESTful API enables you to control, manage, and monitor service robots programmatically. Whether you're building a tablet ordering system, a central control panel, or integrating robots into your existing infrastructure, this API provides everything you need.
Quick Start
The Robot API is organized into logical sections based on functionality. Choose a section below to get started:
Robot Status
Monitor robot health, battery, sensors, and operational state
Navigation
Control movement, set goals, and track position in real-time
Mapping
Create, manage, and switch between maps of physical spaces
Targets
Define and manage named locations (tables, stations, etc.)
Cruise
Create patrol routes with multiple waypoints
Tasks
Assign missions and monitor task execution
Profile and Mode
Adjust robot behavior, speed, and operational modes
User Interface
Control the robot's screen, speech, and user interactions
Layer
Manage map layers and spatial data visualization
Common Use Cases
Monitoring Robot Status
Before assigning tasks, check if the robot is ready using the Robot Status API. Monitor battery levels, emergency stop state, and sensor health.
Moving the Robot
Use the Navigation API to send the robot to specific locations. You can either send coordinates directly or use predefined targets.
Setting Up Your Space
- Create a map using the Mapping API
- Define locations with the Targets API
- Create patrol routes with the Cruise API
Assigning Work
Send tasks to the robot using the Task API. Tasks combine a target location with an action type (like table service or delivery).
Customizing Behavior
Adjust how the robot operates using the Profile and Mode API. Change speed during busy hours or enable special features like elevator mode.
Customer Interaction
Control the robot's display and speech using the User Interface API to enhance customer experience.
Practical Examples
Check out our Guides section for step-by-step tutorials on common tasks:
- Go to Target and Speak - Send the robot to a location and make an announcement
- Start Cruise - Begin a patrol route