Formant Agent SDK

Python client embedded in the `formant` PyPI package (`pip install formant`, `from formant.sdk.agent.v1 import Client`). Runs on-robot alongside the Formant agent and exposes typed ingestion methods — `post_image`, `post_numeric`, `post_numericset`, `post_bitset`, `post_text`, `post_geolocation`, `post_battery`, `post_json` — plus `register_command_request_callback` / `send_command_response` for bidirectional command handling and teleoperation hooks. Stream creation is implicit on first ingest. Use it when you are not on ROS and want to drive Formant from robot-side Python, or when you want finer-grained control than the ROS adapter provides.

Formant Agent SDK is one of 4 APIs that Formant publishes on the APIs.io network.

Tagged areas include SDK, Agent, Python, and Telemetry. The published artifact set on APIs.io includes API documentation and SDKs.

API entry from apis.yml

apis.yml Raw ↑
aid: formant:formant-agent-sdk
name: Formant Agent SDK
description: Python client embedded in the `formant` PyPI package (`pip install formant`, `from formant.sdk.agent.v1
  import Client`). Runs on-robot alongside the Formant agent and exposes typed ingestion methods — `post_image`,
  `post_numeric`, `post_numericset`, `post_bitset`, `post_text`, `post_geolocation`, `post_battery`, `post_json`
  — plus `register_command_request_callback` / `send_command_response` for bidirectional command handling
  and teleoperation hooks. Stream creation is implicit on first ingest. Use it when you are not on ROS
  and want to drive Formant from robot-side Python, or when you want finer-grained control than the ROS
  adapter provides.
humanURL: https://docs.formant.io/reference/agent-sdk-installation-and-overview
tags:
- SDK
- Agent
- Python
- Telemetry
properties:
- type: Documentation
  url: https://docs.formant.io/reference/agent-sdk-installation-and-overview
- type: Documentation
  url: https://docs.formant.io/reference/agent-sdk-reference
- type: Documentation
  url: https://docs.formant.io/reference/agent-sdk-protos
- type: SDK
  url: https://pypi.org/project/formant/