Airbotics Documentation

Documentation

API Reference

Guides

Changelog

Airbotics

Introduction

Send commands to ROS nodes through a REST API.

Commands

Containers

Collect and query data from your robots in real-time.

Data

Stream logs directly from ROS to the cloud.

Logs

Agent

API keys allow clients access to the API.

API keys

Organisations allow multiple team members to collaborate.

Organisations

The API allows programmatic access to Airbotics.

Create a robot

List robots

This endpoint gets details about a robot.

Get a robot

Delete a robot

This endpoint configures vitals collection on a robot

Configure vitals for a robot

This endpoint gets the current configuration of vitals collection on a robot

Get vitals configuration

List vitals

This endpoint deletes all vitals for a robot.

Delete vitals

This endpoint sends a command to a robot.

Send a command

This endpoint lists all commands sent to a robot.

List for a robot

This endpoint lists all commands in your organisation.

List commands

This endpoint gets details about a command.

Get a command

Delete a command

This endpoint creates a new compose file.

Create a compose file

List compose files

This endpoint gets details about a compose file.

Get a compose file

Delete a compose file

This endpoint puts a compose file on a robot.

Put a compose file on a robot

This endpoint gets the compose-file on a robot.

Get the compose file on a robot

This endpoint removes a compose file from a robot.

Remove a compose file from a robot

This endpoint configures logs collection on a robot

Configure logs for a robot

This endpoint gets the current configuration of logs collection on a robot

Get log configuration

List logs

This endpoint deletes all logs for a robot.

Delete logs

This endpoint creates a new data stream for a robot.

Create a data stream

This endpoint lists all data streams for a robot.

List data streams

This endpoint updates a data stream for a robot.

Update a data stream

This endpoint deletes a data stream for a robot.

Delete a data stream

This endpoint lists all data points for a robot.

List data points

Guides on how to get up and running with Airbotics and start building applications.

Take Airbotics for a spin in under 5 minutes.

Quickstart

Build a custom CLI to control your robot on top of Airbotics.

Build a custom CLI

Build a web-based React dashboard to control a robot.

API Reference

Robots

Commands

Containers

Logs

Data

Changelog

2023-07-18

API Reference

Robots

Commands

Containers

Logs

Data

​2023-07-18

2023-07-18