Commands
Send a command
Commands
Send a command
This endpoint sends a command to a robot.
curl --request POST https://api.airbotics.io/robots/robot0/commands \
--header 'content-type: application/json' \
--header 'air-api-key: <token>' \
--data '{
"interface": "topic",
"name": "/text-to-speech",
"type": "std_msgs/msg/String",
"payload": {
"data": "Hello, world!"
}
}'
{
"uuid": "00000000-0000-0000-0000-000000000000"
}
Path parameters
id
string
requiredThe ID of the robot.
Body parameters
interface
string
requiredThe ROS interface to act on. Must be topic, service, action_send_goal.
name
string
requiredThe name of the ROS topic, service or action.
type
string
requiredThe type of interface, e.g. std_msgs/msg/String, geometry_msgs/msg/Twist, etc.
payload
object
requiredThe payload that should be sent to the ROS interface in JSON format.
curl --request POST https://api.airbotics.io/robots/robot0/commands \
--header 'content-type: application/json' \
--header 'air-api-key: <token>' \
--data '{
"interface": "topic",
"name": "/text-to-speech",
"type": "std_msgs/msg/String",
"payload": {
"data": "Hello, world!"
}
}'
{
"uuid": "00000000-0000-0000-0000-000000000000"
}