Skip to main content
POST
/
joints
/
write
Write Joint Positions
curl --request POST \
  --url https://api.example.com/joints/write \
  --header 'Content-Type: application/json' \
  --data '
{
  "angles": [
    123
  ],
  "joints_ids": [
    123
  ],
  "unit": "rad"
}
'
{
  "message": "<string>",
  "status": "ok"
}

Documentation Index

Fetch the complete documentation index at: https://docs.phospho.ai/llms.txt

Use this file to discover all available pages before exploring further.

Query Parameters

​
robot_id
integer
default:0

Body

application/json

Request to set the joints of the robot.

​
angles
number[]
required

A list with the position of each joint. The length of the list must be equal to the number of joints. The unit is given by the 'unit' field.

​
joints_ids
integer[] | null

If set, only set the joints with these ids. If None, set all joints.Example: 'angles'=[1,1,1], 'joints_ids'=[0,1,2] will set the first 3 joints to 1 radian.

​
unit
enum<string>
default:rad

The unit of the angles. Defaults to radian.

Available options:
rad,
motor_units,
degrees

Response

Successful Response

Default response. May contain other fields.

​
message
string | null
​
status
enum<string>
default:ok
Available options:
ok,
error