POSTJSONHTTP/1.1

Server REST API

When the server extension is enabled, every static method decorated with @apiclass is exposed as an HTTP POST endpoint. Request body is JSON with keys matching Python parameters; responses always use the { success, msg, data } envelope.

BASE URLPOSThttp://localhost:8080/{apiclass}/{method}
8route groups
47endpoints
200unified response
Unified response envelope { "success": bool, "msg": string, "data": any }
POST/motion_plan
13 endpoints
  • get_joint_state
  • gen_motion_plan
  • move_robot_to_ee_pose
  • solve_ik
  • solve_fk
  • +8 more
View endpoints
POST/robot
3 endpoints
  • move_robot_along_trajectory
  • solve_ik_no_collision_check
  • move_robot_to_ee_pose_no_collision_check
View endpoints
POST/action
1 endpoint
  • act
View endpoints
POST/spawnable
6 endpoints
  • get_spawnable_data
  • get_bounding_box
  • spawn_with_config
  • control_object
  • control_robot
  • +1 more
View endpoints
POST/visualize
6 endpoints
  • create_pose_visualization
  • create_robot_ee_trajectory_visualization
  • visualize_planner_world_representation
  • visualize_planner_robot_representation
  • visualize_target_bounding_box
  • +1 more
View endpoints
POST/snapshot
5 endpoints
  • save
  • restore
  • delete
  • clear
  • list_snapshots
View endpoints
POST/simulator
5 endpoints
  • get_step_context
  • get_simulation_config
  • is_running
  • request_terminate
  • reset
View endpoints
POST/navigation
8 endpoints
  • navigate_to
  • compute_velocity
  • set_twist
  • stop
  • is_goal_reached
  • +3 more
View endpoints