POST/spawnable/get_spawnable_data
get_spawnable_data
Request Body
FieldTypeDescription
spawnable_namestringSpawnable entry name from config
Response200 OK
FieldTypeDescription
successboolWhether the call succeeded
msgstringStatus or error message
dataobjectPayload; shape depends on the endpoint
Request bodyJSON
{
  "spawnable_name": "x"
}
Response200 OK
{
  "success": true,
  "msg": "ok",
  "data": {}
}
POST/spawnable/get_bounding_box
get_bounding_box
Request Body
FieldTypeDescription
spawnable_namestringSpawnable entry name from config
SimulatorTypestringSimulator backend, e.g. isaaclab
Response200 OK
FieldTypeDescription
successboolWhether the call succeeded
msgstringStatus or error message
dataobjectPayload; shape depends on the endpoint
Request bodyJSON
{
  "spawnable_name": "x",
  "SimulatorType": "isaaclab"
}
Response200 OK
{
  "success": true,
  "msg": "ok",
  "data": {}
}
POST/spawnable/spawn_with_config
spawn_with_config
Request Body
FieldTypeDescription
config_dictobjectSpawn / resource configuration
registerboolRegister the instance in the scene
Response200 OK
FieldTypeDescription
successboolWhether the call succeeded
msgstringStatus or error message
datanullPayload; shape depends on the endpoint
Request bodyJSON
{
  "config_dict": {
    "stereotype": "rigid",
    "name": "o"
  },
  "register": false
}
Response200 OK
{
  "success": true,
  "msg": "ok",
  "data": null
}
POST/spawnable/control_object
control_object
Request Body
FieldTypeDescription
object_namestringTarget object name
functionstringRemote method name (e.g. get_pose)
parametersobjectMethod arguments object
syncboolWait for completion when true
Response200 OK
FieldTypeDescription
successboolWhether the call succeeded
msgstringStatus or error message
dataobjectPayload; shape depends on the endpoint
Request bodyJSON
{
  "object_name": "o",
  "function": "get_pose",
  "parameters": {},
  "sync": true
}
Response200 OK
{
  "success": true,
  "msg": "ok",
  "data": {}
}
POST/spawnable/control_robot
control_robot
Request Body
FieldTypeDescription
robot_namestringRobot asset name in the scene
functionstringRemote method name (e.g. get_pose)
parametersobjectMethod arguments object
syncboolWait for completion when true
Response200 OK
FieldTypeDescription
successboolWhether the call succeeded
msgstringStatus or error message
dataobjectPayload; shape depends on the endpoint
Request bodyJSON
{
  "robot_name": "r",
  "function": "get_joint_position",
  "parameters": {},
  "sync": true
}
Response200 OK
{
  "success": true,
  "msg": "ok",
  "data": {}
}
POST/spawnable/control_sensor
control_sensor
Request Body
FieldTypeDescription
sensor_namestringSensor asset name
functionstringRemote method name (e.g. get_pose)
parametersobjectMethod arguments object
syncboolWait for completion when true
Response200 OK
FieldTypeDescription
successboolWhether the call succeeded
msgstringStatus or error message
dataobjectPayload; shape depends on the endpoint
Request bodyJSON
{
  "sensor_name": "s",
  "function": "get_data",
  "parameters": {},
  "sync": true
}
Response200 OK
{
  "success": true,
  "msg": "ok",
  "data": {}
}