Autoxing REST API Book
  • English
  • zh-CN
GitHub
  • English
  • zh-CN
GitHub
  • Guide

    • Getting Started
    • Start Moving
    • Getting Started with WebSockets
    • Robot Admin (Standalone Version)
  • Reference

    • REST API Principles
    • Map API
    • Move API
    • Current Map and Pose API
    • Overlays
    • Mapping API
    • Service API
    • Forwarded ROS Services API
    • IoT Devices
    • Device Information API
    • Robot Parameters API
    • System Settings
    • App Store API
    • Hostname API
    • Landmarks
    • WebSocket Reference
    • Submaps
  • Other

    • Deprecations
    • Changelog

Autoxing Robot REST API

The Autoxing Robot REST API allows you to command the robot to perform tasks such as mapping, moving, and communicating with other IoT devices (such as gateways or elevators).

TypeScript SDK

A typed TypeScript client is available as @kingsimba/axbot-sdk. It wraps the REST endpoints and WebSocket topics described in this book and provides first-class TypeScript types for all request and response shapes.

An interactive demo application built on top of the SDK is available at axbot-ts-sdk-demo. It shows live REST and WebSocket usage and is a useful starting point for custom integrations.

This TypeScript SDK powers the robot monitoring platform rb-admin.autoxing.com. The SDK and the platform are developed in tandem — API additions, protocol changes, and new capabilities are implemented in the SDK first and consumed by the platform immediately.

Edit this page
Last Updated: 6/14/26, 5:36 AM
Contributors: FengZhaolin