APIs & SDKs

Formant API & SDK Overview

Formant offers a powerful suite of developer tools to programmatically ingest data, command your robot, and manage your Formant organization.

Agent SDK

The Agent SDK is a Python module which runs locally on your device. You can use the Agent SDK to ingest data on your device and transfer it to the Formant cloud. You can also use it to update your device's configuration, create events, handle commands, and manage teleoperation sessions.

📘

When should I use the Agent SDK?

You should use the Agent SDK...

  • If you are not using ROS and you are using Python in robot-side applications.
  • To ingest data via the Formant agent, handle teleoperation sessions on your robot, respond to commands, and create events.
  • To have more control over how your application interacts with Formant (e.g., controlling the ingestion pathway, processing data before ingestion, or running a separate script when a command is received from the Formant web application).

Cloud SDK

The Cloud SDK allows you to interact with data stored in your Formant organization's cloud storage.

📘

When should I use the Cloud SDK?

You should use the Cloud SDK...

  • To query datapoints from your Formant organization.
  • To ingest datapoints to your Formant organization without using the Formant agent.
  • To wrap Admin and Query API calls with easier-to-use Python syntax.

fctl: Formant's command line tool

fctl is the Formant command line tool. fctl can be used to SSH to your device, set up port forwarding, and transfer files. You can also create devices and service accounts, and query data from the Formant cloud.

📘

When should I use fctl?

You should use fctl...

  • To SSH, set up port forwarding, and copy files to and from your device.
  • To write scripts to programmatically create devices.

Admin API

The Admin API contains the majority of functionality to interact with devices, data, users, and other entities in your Formant organization.

📘

When should I use the Admin API?

You should use the Admin API...

  • To create, provision, and configure devices programmatically.
  • To create command templates.
  • To create task reports.
  • To create intervention requests.
  • To use Agent SDK functionality in a language other than Python.

Query API

The Query API allows you to query datapoints in your Formant organization.

📘

When should I use the Query API?

You should use the Query API...

  • To query data from your Formant organization in a language other than Python.

👋

If you notice an issue with this page or need help, please reach out to us! Use the 'Did this page help you?' buttons below, or get in contact with our Customer Success team via the Intercom messenger in the bottom-right corner of this page, or at [email protected].