Standard Bots
Standard Bots API Manual

Download PDF Contact Support

Last updated on September 28, 2026


Table of Contents

  • 1 Introduction
    • 1.1 Welcome!
    • 1.2 Contacting Standard Bots Support
    • 1.3 Intended Use & Limitations
    • 1.4 Warnings & Risks
  • 2 API & ROS2 Overview
    • 2.1 When to Use the SDK and REST API vs ROS2 Bridge
  • 3 API
    • 3.1 Python SDK
    • 3.2 Installing and Authenticating
    • 3.3 Connecting to the Robot
    • 3.4 How Every Call Works
    • 3.5 Control Surface Reference
    • 3.6 The Pattern for Any Motion
    • 3.7 Use Case A – Reading Live Robot State
    • 3.8 Use Case B – Moving the Arm to a Pose
    • 3.9 Use Case C – Running a Saved Routine
    • 3.10 Use Case D – Controlling the Gripper
    • 3.11 Use Case E – Reading and Writing I/O
    • 3.12 Use Case F – Recovering from a Fault or E-Stop
    • 3.13 Use Case G – Using a Saved Space
    • 3.14 Use Case H – Setting the Payload
    • 3.15 Use Case I – Triggering a Software Emergency Stop
    • 3.16 Troubleshooting
    • 3.17 Known Limitations
    • 3.18 REST API
  • 4 ROS2
    • 4.1 ROS2 Setup
    • 4.2 ROS2 Python Scripting
    • 4.3 Before You Write Code
    • 4.4 Topic Reference
    • 4.5 The Mandatory Pattern: Enable, Work, Disable
    • 4.6 Use Case A – Monitoring Live Joint Angles
    • 4.7 Use Case B – Reading the Live TCP Pose
    • 4.8 Use Case C – Commanding a Cartesian Move
    • 4.9 Use Case D – Closing the Loop on a Moving Target
    • 4.10 Use Case E – Streaming a Joint Trajectory
    • 4.11 Troubleshooting
    • 4.12 Known Limitations
    • 4.13 Sample Scripts
  • 5 External Control (Beta)
    • 5.1 How External Control Relates to the ROS2 Realtime API
    • 5.2 How a Session Works
    • 5.3 Prerequisites
    • 5.4 Getting Started with Joint Streaming
    • 5.5 Command Topics
    • 5.6 State Topics
    • 5.7 External Control REST Reference
    • 5.8 Control and Safety Semantics
    • 5.9 What Ends a Session and How to Recover
    • 5.10 Streaming from Python without ROS2
    • 5.11 Direct UDP Interface
    • 5.12 Troubleshooting
    • 5.13 Known Limitations
  • 6 Additional Resources
    • 6.1 Python SDK & REST API Repo
    • 6.2 ROS2 Repo
    • 6.3 Robot URDF Files
© 2023 Standard Bots Company. All rights reserved.