Robot WebUI: per-operation parameter and implementation index

This reference covers every route declaration discovered in the inspected service source. It complements the human-written service guides and typed model reference. Fields inferred from dictionary access are observations, not a complete validation schema. Response expressions in the route reference preserve implementation details where the handler has no declared response model.

Framework-injected Request/WebSocket parameters are not HTTP query fields. Path captures are URL encoded; scalar parameters outside the path are query parameters in FastAPI, while dict/model parameters are JSON bodies. UploadFile uses multipart form data. Flask TTS query behavior is described in its service guide.

GET /api/robot/config

Handler: robot_config. Source: head-ros-nodes/ros/webui/api/webui_api/api_routes.py:57. Behavior and examples.

No explicit handler arguments beyond framework state.

Direct source delegates (static trace):

• robot_profile in head-ros-nodes/ros/webui/api/webui_api/adapters/ros2.py:514

Request template (uses configured service base URL):

curl --fail-with-body "$SERVICE_URL/api/robot/config"

GET /api/robot/config/schema

Handler: robot_config_schema. Source: head-ros-nodes/ros/webui/api/webui_api/api_routes.py:74. Behavior and examples.

No explicit handler arguments beyond framework state.

Request template (uses configured service base URL):

curl --fail-with-body "$SERVICE_URL/api/robot/config/schema"

GET /api/robot/config/{name}

Handler: robot_config_by_name. Source: head-ros-nodes/ros/webui/api/webui_api/api_routes.py:85. Behavior and examples.

Argument	Location	Type	Default
name	path	str	required

POST /api/robot/config/{name}

Handler: save_robot_config. Source: head-ros-nodes/ros/webui/api/webui_api/api_routes.py:94. Behavior and examples.

Argument	Location	Type	Default
name	path	str	required
payload	JSON body/model	dict	required

Observed dictionary fields (including directly traced delegate methods):

Object	Field	Lookup default
payload	data	payload

This operation may change runtime, files, host configuration or hardware. Read its guide and current input contract before calling. There is no general exactly-once or cancellation guarantee.

GET /api/virtual-project

Handler: virtual_project. Source: head-ros-nodes/ros/webui/api/webui_api/api_routes.py:101. Behavior and examples.

No explicit handler arguments beyond framework state.

Direct source delegates (static trace):

• virtual_character_name in head-ros-nodes/ros/webui/api/webui_api/adapters/ros2.py:1986

Request template (uses configured service base URL):

curl --fail-with-body "$SERVICE_URL/api/virtual-project"

GET /api/settings/nodes

Handler: settings_nodes. Source: head-ros-nodes/ros/webui/api/webui_api/api_routes.py:189. Behavior and examples.

No explicit handler arguments beyond framework state.

Direct source delegates (static trace):

• list_settings_nodes in head-ros-nodes/ros/webui/api/webui_api/adapters/ros2.py:1886

Request template (uses configured service base URL):

curl --fail-with-body "$SERVICE_URL/api/settings/nodes"

GET /api/settings/nodes/{node_name:path}/description

Handler: settings_node_description. Source: head-ros-nodes/ros/webui/api/webui_api/api_routes.py:194. Behavior and examples.

Argument	Location	Type	Default
node_name	path	str	required

Direct source delegates (static trace):

• describe_settings_node in head-ros-nodes/ros/webui/api/webui_api/adapters/ros2.py:1860

GET /api/settings/nodes/{node_name:path}/configuration

Handler: settings_node_configuration. Source: head-ros-nodes/ros/webui/api/webui_api/api_routes.py:199. Behavior and examples.

Argument	Location	Type	Default
node_name	path	str	required

Direct source delegates (static trace):

• get_settings_node_configuration in head-ros-nodes/ros/webui/api/webui_api/adapters/ros2.py:1129

POST /api/settings/nodes/{node_name:path}/configuration

Handler: save_settings_node_configuration. Source: head-ros-nodes/ros/webui/api/webui_api/api_routes.py:204. Behavior and examples.

Argument	Location	Type	Default
node_name	path	str	required
payload	JSON body/model	dict	required

Observed dictionary fields (including directly traced delegate methods):

Object	Field	Lookup default
payload	values	payload

Direct source delegates (static trace):

• save_settings_node_configuration in head-ros-nodes/ros/webui/api/webui_api/adapters/ros2.py:1149

This operation may change runtime, files, host configuration or hardware. Read its guide and current input contract before calling. There is no general exactly-once or cancellation guarantee.

POST /api/settings/nodes/{node_name:path}/save

Handler: save_settings_node_file. Source: head-ros-nodes/ros/webui/api/webui_api/api_routes.py:209. Behavior and examples.

Argument	Location	Type	Default
node_name	path	str	required

Direct source delegates (static trace):

• save_settings_node_file in head-ros-nodes/ros/webui/api/webui_api/adapters/ros2.py:1890

This operation may change runtime, files, host configuration or hardware. Read its guide and current input contract before calling. There is no general exactly-once or cancellation guarantee.

POST /api/settings/nodes/{node_name:path}/reset

Handler: reset_settings_node_configuration. Source: head-ros-nodes/ros/webui/api/webui_api/api_routes.py:214. Behavior and examples.

Argument	Location	Type	Default
node_name	path	str	required

Direct source delegates (static trace):

• reset_settings_node_configuration in head-ros-nodes/ros/webui/api/webui_api/adapters/ros2.py:1896

This operation may change runtime, files, host configuration or hardware. Read its guide and current input contract before calling. There is no general exactly-once or cancellation guarantee.

GET /api/settings/nodes/{node_name:path}/saved-file

Handler: settings_node_saved_file. Source: head-ros-nodes/ros/webui/api/webui_api/api_routes.py:219. Behavior and examples.

Argument	Location	Type	Default
node_name	path	str	required

Direct source delegates (static trace):

• settings_node_saved_file in head-ros-nodes/ros/webui/api/webui_api/adapters/ros2.py:1900

DELETE /api/settings/nodes/{node_name:path}/saved-file

Handler: delete_settings_node_saved_file. Source: head-ros-nodes/ros/webui/api/webui_api/api_routes.py:224. Behavior and examples.

Argument	Location	Type	Default
node_name	path	str	required

Direct source delegates (static trace):

• delete_settings_node_saved_file in head-ros-nodes/ros/webui/api/webui_api/adapters/ros2.py:1906

This operation may change runtime, files, host configuration or hardware. Read its guide and current input contract before calling. There is no general exactly-once or cancellation guarantee.

GET /api/settings/suggestions

Handler: settings_suggestions. Source: head-ros-nodes/ros/webui/api/webui_api/api_routes.py:229. Behavior and examples.

No explicit handler arguments beyond framework state.

Direct source delegates (static trace):

• settings_suggestions in head-ros-nodes/ros/webui/api/webui_api/adapters/ros2.py:813

Request template (uses configured service base URL):

curl --fail-with-body "$SERVICE_URL/api/settings/suggestions"

GET /api/monitor/status

Handler: monitor_status. Source: head-ros-nodes/ros/webui/api/webui_api/api_routes.py:234. Behavior and examples.

No explicit handler arguments beyond framework state.

Direct source delegates (static trace):

• monitor_status in head-ros-nodes/ros/webui/api/webui_api/adapters/ros2.py:559

Request template (uses configured service base URL):

curl --fail-with-body "$SERVICE_URL/api/monitor/status"

GET /api/faces

Handler: faces. Source: head-ros-nodes/ros/webui/api/webui_api/api_routes.py:239. Behavior and examples.

No explicit handler arguments beyond framework state.

Direct source delegates (static trace):

• list_faces in head-ros-nodes/ros/webui/api/webui_api/face_store.py:65

Request template (uses configured service base URL):

curl --fail-with-body "$SERVICE_URL/api/faces"

GET /api/faces/recognition-settings

Handler: face_recognition_settings. Source: head-ros-nodes/ros/webui/api/webui_api/api_routes.py:244. Behavior and examples.

No explicit handler arguments beyond framework state.

Direct source delegates (static trace):

• face_recognition_settings in head-ros-nodes/ros/webui/api/webui_api/adapters/base.py:69

Request template (uses configured service base URL):

curl --fail-with-body "$SERVICE_URL/api/faces/recognition-settings"

POST /api/faces/recognition-settings

Handler: save_face_recognition_settings. Source: head-ros-nodes/ros/webui/api/webui_api/api_routes.py:249. Behavior and examples.

Argument	Location	Type	Default
payload	JSON body/model	dict	required

Observed dictionary fields (including directly traced delegate methods):

Object	Field	Lookup default
payload	threshold	None

Direct source delegates (static trace):

• set_recognition_settings in head-ros-nodes/ros/webui/api/webui_api/face_store.py:78
• set_face_recognition_settings in head-ros-nodes/ros/webui/api/webui_api/adapters/ros2.py:297

Explicit handler errors:

HTTPException(status_code=400, detail={'error': 'missing_threshold'})

This operation may change runtime, files, host configuration or hardware. Read its guide and current input contract before calling. There is no general exactly-once or cancellation guarantee.

POST /api/faces

Handler: save_face. Source: head-ros-nodes/ros/webui/api/webui_api/api_routes.py:259. Behavior and examples.

Argument	Location	Type	Default
payload	JSON body/model	dict	required

Observed dictionary fields (including directly traced delegate methods):

Object	Field	Lookup default
payload	display_name	None
payload	enabled	None
payload	id	None
payload	info	None
payload	name	None

Direct source delegates (static trace):

• upsert_face in head-ros-nodes/ros/webui/api/webui_api/face_store.py:92

This operation may change runtime, files, host configuration or hardware. Read its guide and current input contract before calling. There is no general exactly-once or cancellation guarantee.

DELETE /api/faces/{face_id}

Handler: delete_face. Source: head-ros-nodes/ros/webui/api/webui_api/api_routes.py:270. Behavior and examples.

Argument	Location	Type	Default
face_id	path	str	required

Direct source delegates (static trace):

• delete_face in head-ros-nodes/ros/webui/api/webui_api/face_store.py:122

This operation may change runtime, files, host configuration or hardware. Read its guide and current input contract before calling. There is no general exactly-once or cancellation guarantee.

GET /api/faces/images/{image_path:path}

Handler: face_image. Source: head-ros-nodes/ros/webui/api/webui_api/api_routes.py:275. Behavior and examples.

Argument	Location	Type	Default
image_path	path	str	required

Explicit handler errors:

HTTPException(status_code=404, detail='Image not found')

POST /api/faces/{face_id}/images

Handler: add_face_image. Source: head-ros-nodes/ros/webui/api/webui_api/api_routes.py:286. Behavior and examples.

Argument	Location	Type	Default
face_id	path	str	required
file	multipart field	UploadFile	File(...)

Direct source delegates (static trace):

• upsert_face in head-ros-nodes/ros/webui/api/webui_api/face_store.py:92
• save_face_image in head-ros-nodes/ros/webui/api/webui_api/face_store.py:187
• add_image_metadata in head-ros-nodes/ros/webui/api/webui_api/face_store.py:199
• add_embedding in head-ros-nodes/ros/webui/api/webui_api/face_store.py:148
• extract_face_embedding_from_bytes in head-ros-nodes/ros/webui/api/webui_api/adapters/ros2.py:1376
• find_face in head-ros-nodes/ros/webui/api/webui_api/face_store.py:85

This operation may change runtime, files, host configuration or hardware. Read its guide and current input contract before calling. There is no general exactly-once or cancellation guarantee.

POST /api/faces/{face_id}/regenerate

Handler: regenerate_face_embeddings. Source: head-ros-nodes/ros/webui/api/webui_api/api_routes.py:408. Behavior and examples.

Argument	Location	Type	Default
face_id	path	str	required

Direct source delegates (static trace):

• find_face in head-ros-nodes/ros/webui/api/webui_api/face_store.py:85

Explicit handler errors:

HTTPException(status_code=404, detail='Face not found')

This operation may change runtime, files, host configuration or hardware. Read its guide and current input contract before calling. There is no general exactly-once or cancellation guarantee.

POST /api/faces/regenerate

Handler: regenerate_all_face_embeddings. Source: head-ros-nodes/ros/webui/api/webui_api/api_routes.py:415. Behavior and examples.

No explicit handler arguments beyond framework state.

This operation may change runtime, files, host configuration or hardware. Read its guide and current input contract before calling. There is no general exactly-once or cancellation guarantee.

POST /api/faces/search

Handler: search_face. Source: head-ros-nodes/ros/webui/api/webui_api/api_routes.py:420. Behavior and examples.

Argument	Location	Type	Default
payload	JSON body/model	dict	required

Observed dictionary fields (including directly traced delegate methods):

Object	Field	Lookup default
payload	embedding	None
payload	model	None
payload	threshold	None

Direct source delegates (static trace):

• search_embedding in head-ros-nodes/ros/webui/api/webui_api/face_store.py:219
• face_recognition_settings in head-ros-nodes/ros/webui/api/webui_api/adapters/base.py:69

Explicit handler errors:

HTTPException(status_code=400, detail='Missing embedding')

This operation may change runtime, files, host configuration or hardware. Read its guide and current input contract before calling. There is no general exactly-once or cancellation guarantee.

GET /api/faces/live-candidates

Handler: face_live_candidates. Source: head-ros-nodes/ros/webui/api/webui_api/api_routes.py:435. Behavior and examples.

No explicit handler arguments beyond framework state.

Direct source delegates (static trace):

• face_live_candidates in head-ros-nodes/ros/webui/api/webui_api/adapters/ros2.py:1393

Request template (uses configured service base URL):

curl --fail-with-body "$SERVICE_URL/api/faces/live-candidates"

GET /api/teleops/state

Handler: teleops_state. Source: head-ros-nodes/ros/webui/api/webui_api/api_routes.py:440. Behavior and examples.

No explicit handler arguments beyond framework state.

Direct source delegates (static trace):

• teleops_state in head-ros-nodes/ros/webui/api/webui_api/adapters/ros2.py:846

Request template (uses configured service base URL):

curl --fail-with-body "$SERVICE_URL/api/teleops/state"

GET /api/teleops/catalog

Handler: teleops_catalog. Source: head-ros-nodes/ros/webui/api/webui_api/api_routes.py:445. Behavior and examples.

No explicit handler arguments beyond framework state.

Direct source delegates (static trace):

• teleops_catalog in head-ros-nodes/ros/webui/api/webui_api/adapters/ros2.py:885

Request template (uses configured service base URL):

curl --fail-with-body "$SERVICE_URL/api/teleops/catalog"

GET /api/teleops/settings

Handler: teleops_settings. Source: head-ros-nodes/ros/webui/api/webui_api/api_routes.py:450. Behavior and examples.

No explicit handler arguments beyond framework state.

Direct source delegates (static trace):

• teleops_settings in head-ros-nodes/ros/webui/api/webui_api/adapters/ros2.py:906

Request template (uses configured service base URL):

curl --fail-with-body "$SERVICE_URL/api/teleops/settings"

POST /api/teleops/command

Handler: teleops_command. Source: head-ros-nodes/ros/webui/api/webui_api/api_routes.py:455. Behavior and examples.

Argument	Location	Type	Default
payload	JSON body/model	dict	required

Observed dictionary fields (including directly traced delegate methods):

Object	Field	Lookup default
message	action	None
message	agentId	None
message	commandId	None
message	enabled	None
message	key	None
message	language	None
message	mode	None
message	options	{}
message	pose	None
message	requestId	None
message	situation	None
message	state	None
message	type	None
message	value	None
message	voice	None

Direct source delegates (static trace):

• handle_command in head-ros-nodes/ros/webui/api/webui_api/adapters/ros2.py:718

This operation may change runtime, files, host configuration or hardware. Read its guide and current input contract before calling. There is no general exactly-once or cancellation guarantee.

POST /api/settings/trees/{tree_name:path}

Handler: save_tree. Source: head-ros-nodes/ros/webui/api/webui_api/api_routes.py:462. Behavior and examples.

Argument	Location	Type	Default
tree_name	path	str	required
payload	JSON body/model	dict	required

Observed dictionary fields (including directly traced delegate methods):

Object	Field	Lookup default
payload	data	payload

This operation may change runtime, files, host configuration or hardware. Read its guide and current input contract before calling. There is no general exactly-once or cancellation guarantee.

GET /api/settings/trees/{tree_name:path}

Handler: get_tree. Source: head-ros-nodes/ros/webui/api/webui_api/api_routes.py:469. Behavior and examples.

Argument	Location	Type	Default
tree_name	path	str	required

DELETE /api/settings/trees/{tree_name:path}

Handler: remove_tree. Source: head-ros-nodes/ros/webui/api/webui_api/api_routes.py:475. Behavior and examples.

Argument	Location	Type	Default
tree_name	path	str	required

This operation may change runtime, files, host configuration or hardware. Read its guide and current input contract before calling. There is no general exactly-once or cancellation guarantee.

GET /api/motors

Handler: motors. Source: head-ros-nodes/ros/webui/api/webui_api/api_routes.py:483. Behavior and examples.

No explicit handler arguments beyond framework state.

Direct source delegates (static trace):

• list_motors in head-ros-nodes/ros/webui/api/webui_api/adapters/ros2.py:569

Request template (uses configured service base URL):

curl --fail-with-body "$SERVICE_URL/api/motors"

GET /api/motors/states

Handler: motor_states. Source: head-ros-nodes/ros/webui/api/webui_api/api_routes.py:488. Behavior and examples.

No explicit handler arguments beyond framework state.

Direct source delegates (static trace):

• motor_states in head-ros-nodes/ros/webui/api/webui_api/adapters/ros2.py:576

Request template (uses configured service base URL):

curl --fail-with-body "$SERVICE_URL/api/motors/states"

POST /api/motors/control

Handler: motor_control. Source: head-ros-nodes/ros/webui/api/webui_api/api_routes.py:493. Behavior and examples.

Argument	Location	Type	Default
payload	JSON body/model	dict	required

Observed dictionary fields (including directly traced delegate methods):

Object	Field	Lookup default
payload	enabled	None

Direct source delegates (static trace):

• set_motor_control in head-ros-nodes/ros/webui/api/webui_api/adapters/ros2.py:583

This operation may change runtime, files, host configuration or hardware. Read its guide and current input contract before calling. There is no general exactly-once or cancellation guarantee.

POST /api/motors/command

Handler: motor_command. Source: head-ros-nodes/ros/webui/api/webui_api/api_routes.py:498. Behavior and examples.

Argument	Location	Type	Default
payload	JSON body/model	dict	required

Observed dictionary fields (including directly traced delegate methods):

Object	Field	Lookup default
payload	max	None
payload	min	None
payload	name	None
payload	value	None

Direct source delegates (static trace):

• send_motor_command in head-ros-nodes/ros/webui/api/webui_api/adapters/ros2.py:592

This operation may change runtime, files, host configuration or hardware. Read its guide and current input contract before calling. There is no general exactly-once or cancellation guarantee.

POST /api/motors/torque

Handler: motor_torque. Source: head-ros-nodes/ros/webui/api/webui_api/api_routes.py:503. Behavior and examples.

Argument	Location	Type	Default
payload	JSON body/model	dict	required

Observed dictionary fields (including directly traced delegate methods):

Object	Field	Lookup default
payload	enabled	None
payload	names	None

Direct source delegates (static trace):

• set_motor_torque in head-ros-nodes/ros/webui/api/webui_api/adapters/ros2.py:612

This operation may change runtime, files, host configuration or hardware. Read its guide and current input contract before calling. There is no general exactly-once or cancellation guarantee.

GET /api/motors/config

Handler: motors_config. Source: head-ros-nodes/ros/webui/api/webui_api/api_routes.py:508. Behavior and examples.

No explicit handler arguments beyond framework state.

Direct source delegates (static trace):

• motor_config in head-ros-nodes/ros/webui/api/webui_api/adapters/ros2.py:1836

Request template (uses configured service base URL):

curl --fail-with-body "$SERVICE_URL/api/motors/config"

POST /api/motors/config

Handler: save_motors_config. Source: head-ros-nodes/ros/webui/api/webui_api/api_routes.py:518. Behavior and examples.

Argument	Location	Type	Default
payload	JSON body/model	dict	required

Observed dictionary fields (including directly traced delegate methods):

Object	Field	Lookup default
payload	data	payload
payload	motors	payload

Direct source delegates (static trace):

• save_motor_config in head-ros-nodes/ros/webui/api/webui_api/adapters/ros2.py:640

This operation may change runtime, files, host configuration or hardware. Read its guide and current input contract before calling. There is no general exactly-once or cancellation guarantee.

GET /api/navigation/locations

Handler: navigation_locations. Source: head-ros-nodes/ros/webui/api/webui_api/api_routes.py:528. Behavior and examples.

No explicit handler arguments beyond framework state.

Request template (uses configured service base URL):

curl --fail-with-body "$SERVICE_URL/api/navigation/locations"

POST /api/navigation/go-to

Handler: navigation_go_to. Source: head-ros-nodes/ros/webui/api/webui_api/api_routes.py:533. Behavior and examples.

Argument	Location	Type	Default
payload	JSON body/model	dict	required

This operation may change runtime, files, host configuration or hardware. Read its guide and current input contract before calling. There is no general exactly-once or cancellation guarantee.

POST /api/navigation/go-to-position

Handler: navigation_go_to_position. Source: head-ros-nodes/ros/webui/api/webui_api/api_routes.py:538. Behavior and examples.

Argument	Location	Type	Default
payload	JSON body/model	dict	required

This operation may change runtime, files, host configuration or hardware. Read its guide and current input contract before calling. There is no general exactly-once or cancellation guarantee.

POST /api/navigation/stop

Handler: navigation_stop. Source: head-ros-nodes/ros/webui/api/webui_api/api_routes.py:543. Behavior and examples.

Argument	Location	Type	Default
payload	JSON body/model	dict	required

This operation may change runtime, files, host configuration or hardware. Read its guide and current input contract before calling. There is no general exactly-once or cancellation guarantee.

GET /api/performances

Handler: performances. Source: head-ros-nodes/ros/webui/api/webui_api/api_routes.py:548. Behavior and examples.

Argument	Location	Type	Default
tree	query/framework-specific	bool	False

Direct source delegates (static trace):

• performance_tree in head-ros-nodes/ros/webui/api/webui_api/performance_storage.py:154

Request template (uses configured service base URL):

curl --fail-with-body "$SERVICE_URL/api/performances"

GET /api/performances/current

Handler: current_performance_payload. Source: head-ros-nodes/ros/webui/api/webui_api/api_routes.py:559. Behavior and examples.

No explicit handler arguments beyond framework state.

Direct source delegates (static trace):

• performance_current_payload in head-ros-nodes/ros/webui/api/webui_api/adapters/ros2.py:1970

Request template (uses configured service base URL):

curl --fail-with-body "$SERVICE_URL/api/performances/current"

GET /api/performances/{item_path:path}

Handler: performance_item. Source: head-ros-nodes/ros/webui/api/webui_api/api_routes.py:564. Behavior and examples.

Argument	Location	Type	Default
item_path	path	str	required

Direct source delegates (static trace):

• load_performance in head-ros-nodes/ros/webui/api/webui_api/performance_storage.py:64

Explicit handler errors:

HTTPException(status_code=400, detail=str(error))

POST /api/performances/{item_path:path}

Handler: save_performance_item. Source: head-ros-nodes/ros/webui/api/webui_api/api_routes.py:572. Behavior and examples.

Argument	Location	Type	Default
item_path	path	str	required
payload	JSON body/model	dict	required

Observed dictionary fields (including directly traced delegate methods):

Object	Field	Lookup default
payload	baseRevision	None
payload	data	payload
payload	force	None

Direct source delegates (static trace):

• save_performance in head-ros-nodes/ros/webui/api/webui_api/performance_storage.py:97

Explicit handler errors:

HTTPException(status_code=409, detail={'error': 'Performance changed since it was loaded', 'id': error.item_id, 'currentRevision': error.current_revision})
HTTPException(status_code=400, detail=str(error))

This operation may change runtime, files, host configuration or hardware. Read its guide and current input contract before calling. There is no general exactly-once or cancellation guarantee.

DELETE /api/performances/{item_path:path}

Handler: delete_performance_item. Source: head-ros-nodes/ros/webui/api/webui_api/api_routes.py:589. Behavior and examples.

Argument	Location	Type	Default
item_path	path	str	required

Direct source delegates (static trace):

• delete_performance in head-ros-nodes/ros/webui/api/webui_api/performance_storage.py:127

Explicit handler errors:

HTTPException(status_code=400, detail=str(error))

This operation may change runtime, files, host configuration or hardware. Read its guide and current input contract before calling. There is no general exactly-once or cancellation guarantee.

POST /api/performance-folders/{folder_path:path}

Handler: create_performance_folder. Source: head-ros-nodes/ros/webui/api/webui_api/api_routes.py:597. Behavior and examples.

Argument	Location	Type	Default
folder_path	path	str	required

Direct source delegates (static trace):

• create_folder in head-ros-nodes/ros/webui/api/webui_api/performance_storage.py:137

Explicit handler errors:

HTTPException(status_code=400, detail=str(error))

This operation may change runtime, files, host configuration or hardware. Read its guide and current input contract before calling. There is no general exactly-once or cancellation guarantee.

POST /api/performance-move/{item_path:path}

Handler: move_performance_item. Source: head-ros-nodes/ros/webui/api/webui_api/api_routes.py:605. Behavior and examples.

Argument	Location	Type	Default
item_path	path	str	required
payload	JSON body/model	dict	required

Observed dictionary fields (including directly traced delegate methods):

Object	Field	Lookup default
payload	targetId	None

Direct source delegates (static trace):

• move_performance in head-ros-nodes/ros/webui/api/webui_api/performance_storage.py:143

Explicit handler errors:

HTTPException(status_code=400, detail=str(error))

This operation may change runtime, files, host configuration or hardware. Read its guide and current input contract before calling. There is no general exactly-once or cancellation guarantee.

GET /api/performance-properties

Handler: root_performance_properties. Source: head-ros-nodes/ros/webui/api/webui_api/api_routes.py:613. Behavior and examples.

No explicit handler arguments beyond framework state.

Direct source delegates (static trace):

• read_properties in head-ros-nodes/ros/webui/api/webui_api/performance_storage.py:204

Request template (uses configured service base URL):

curl --fail-with-body "$SERVICE_URL/api/performance-properties"

GET /api/performance-properties/{property_path:path}

Handler: performance_properties. Source: head-ros-nodes/ros/webui/api/webui_api/api_routes.py:618. Behavior and examples.

Argument	Location	Type	Default
property_path	path	str	required

Direct source delegates (static trace):

• read_properties in head-ros-nodes/ros/webui/api/webui_api/performance_storage.py:204

Explicit handler errors:

HTTPException(status_code=400, detail=str(error))

POST /api/performance-properties/{property_path:path}

Handler: save_performance_properties. Source: head-ros-nodes/ros/webui/api/webui_api/api_routes.py:626. Behavior and examples.

Argument	Location	Type	Default
property_path	path	str	required
payload	JSON body/model	dict	required

Observed dictionary fields (including directly traced delegate methods):

Object	Field	Lookup default
payload	data	payload

Direct source delegates (static trace):

• write_properties in head-ros-nodes/ros/webui/api/webui_api/performance_storage.py:215

Explicit handler errors:

HTTPException(status_code=400, detail=str(error))

This operation may change runtime, files, host configuration or hardware. Read its guide and current input contract before calling. There is no general exactly-once or cancellation guarantee.

GET /api/performance-catalog

Handler: performance_catalog. Source: head-ros-nodes/ros/webui/api/webui_api/api_routes.py:634. Behavior and examples.

No explicit handler arguments beyond framework state.

Direct source delegates (static trace):

• performance_catalog in head-ros-nodes/ros/webui/api/webui_api/adapters/ros2.py:820

Request template (uses configured service base URL):

curl --fail-with-body "$SERVICE_URL/api/performance-catalog"

POST /api/performance-runtime/speech-length

Handler: performance_speech_length. Source: head-ros-nodes/ros/webui/api/webui_api/api_routes.py:639. Behavior and examples.

Argument	Location	Type	Default
payload	JSON body/model	dict	required

Observed dictionary fields (including directly traced delegate methods):

Object	Field	Lookup default
payload	lang	None
payload	language	None
payload	speed	None
payload	text	None

Direct source delegates (static trace):

• performance_speech_length in head-ros-nodes/ros/webui/api/webui_api/adapters/ros2.py:925

This operation may change runtime, files, host configuration or hardware. Read its guide and current input contract before calling. There is no general exactly-once or cancellation guarantee.

POST /api/performance-runtime/animation-length

Handler: performance_animation_length. Source: head-ros-nodes/ros/webui/api/webui_api/api_routes.py:644. Behavior and examples.

Argument	Location	Type	Default
payload	JSON body/model	dict	required

Observed dictionary fields (including directly traced delegate methods):

Object	Field	Lookup default
payload	gesture	None
payload	name	None

Direct source delegates (static trace):

• performance_animation_length in head-ros-nodes/ros/webui/api/webui_api/adapters/ros2.py:937

This operation may change runtime, files, host configuration or hardware. Read its guide and current input contract before calling. There is no general exactly-once or cancellation guarantee.

POST /api/performance-runtime/arm-animation-length

Handler: performance_arm_animation_length. Source: head-ros-nodes/ros/webui/api/webui_api/api_routes.py:649. Behavior and examples.

Argument	Location	Type	Default
payload	JSON body/model	dict	required

Observed dictionary fields (including directly traced delegate methods):

Object	Field	Lookup default
payload	arm_animation	None
payload	name	None

Direct source delegates (static trace):

• performance_arm_animation_length in head-ros-nodes/ros/webui/api/webui_api/adapters/ros2.py:944

This operation may change runtime, files, host configuration or hardware. Read its guide and current input contract before calling. There is no general exactly-once or cancellation guarantee.

POST /api/performance-runtime/tts-preview

Handler: performance_tts_preview. Source: head-ros-nodes/ros/webui/api/webui_api/api_routes.py:654. Behavior and examples.

Argument	Location	Type	Default
payload	JSON body/model	dict	required

Observed dictionary fields (including directly traced delegate methods):

Object	Field	Lookup default
payload	lang	None
payload	language	None
payload	requestId	None
payload	text	None
payload	voice	None

Direct source delegates (static trace):

• performance_tts_preview in head-ros-nodes/ros/webui/api/webui_api/adapters/ros2.py:951

This operation may change runtime, files, host configuration or hardware. Read its guide and current input contract before calling. There is no general exactly-once or cancellation guarantee.

POST /api/performance-runtime/preview

Handler: performance_preview. Source: head-ros-nodes/ros/webui/api/webui_api/api_routes.py:659. Behavior and examples.

Argument	Location	Type	Default
payload	JSON body/model	dict	required

Observed dictionary fields (including directly traced delegate methods):

Object	Field	Lookup default
payload	name	None
payload	node	None
payload	type	None

Direct source delegates (static trace):

• performance_preview in head-ros-nodes/ros/webui/api/webui_api/adapters/ros2.py:1912

This operation may change runtime, files, host configuration or hardware. Read its guide and current input contract before calling. There is no general exactly-once or cancellation guarantee.

GET /api/performance-runtime/autopause

Handler: performance_autopause. Source: head-ros-nodes/ros/webui/api/webui_api/api_routes.py:664. Behavior and examples.

No explicit handler arguments beyond framework state.

Direct source delegates (static trace):

• performance_autopause in head-ros-nodes/ros/webui/api/webui_api/adapters/ros2.py:961

Request template (uses configured service base URL):

curl --fail-with-body "$SERVICE_URL/api/performance-runtime/autopause"

GET /api/compat/legacy-routes

Handler: legacy_routes. Source: head-ros-nodes/ros/webui/api/webui_api/api_routes.py:670. Behavior and examples.

No explicit handler arguments beyond framework state.

Request template (uses configured service base URL):

curl --fail-with-body "$SERVICE_URL/api/compat/legacy-routes"

GET /api/health

Handler: health. Source: head-ros-nodes/ros/webui/api/webui_api/main.py:360. Behavior and examples.

No explicit handler arguments beyond framework state.

Direct source delegates (static trace):

• health in head-ros-nodes/ros/webui/api/webui_api/adapters/ros2.py:509

Request template (uses configured service base URL):

curl --fail-with-body "$SERVICE_URL/api/health"

GET /api/version

Handler: version. Source: head-ros-nodes/ros/webui/api/webui_api/main.py:371. Behavior and examples.

No explicit handler arguments beyond framework state.

Request template (uses configured service base URL):

curl --fail-with-body "$SERVICE_URL/api/version"

GET /api/status

Handler: status. Source: head-ros-nodes/ros/webui/api/webui_api/main.py:379. Behavior and examples.

No explicit handler arguments beyond framework state.

Request template (uses configured service base URL):

curl --fail-with-body "$SERVICE_URL/api/status"

GET /api/video/fov.mjpg

Handler: fov_mjpeg. Source: head-ros-nodes/ros/webui/api/webui_api/main.py:386. Behavior and examples.

Argument	Location	Type	Default
frames	query/framework-specific	int \| None	None

Direct source delegates (static trace):

• wait_for_fov_frame in head-ros-nodes/ros/webui/api/webui_api/adapters/base.py:56

Explicit handler errors:

HTTPException(status_code=503, detail='No FOV image frame is available yet.')

Request template (uses configured service base URL):

curl --fail-with-body "$SERVICE_URL/api/video/fov.mjpg"

GET /api/video/fov.jpg

Handler: fov_jpeg. Source: head-ros-nodes/ros/webui/api/webui_api/main.py:437. Behavior and examples.

Argument	Location	Type	Default
after	query/framework-specific	int \| None	None
timeout	query/framework-specific	float	0.5

Direct source delegates (static trace):

• latest_fov_frame in head-ros-nodes/ros/webui/api/webui_api/adapters/ros2.py:1562
• wait_for_fov_frame in head-ros-nodes/ros/webui/api/webui_api/adapters/base.py:56

Request template (uses configured service base URL):

curl --fail-with-body "$SERVICE_URL/api/video/fov.jpg"

GET /api/tts/files

Handler: tts_files. Source: head-ros-nodes/ros/webui/api/webui_api/main.py:469. Behavior and examples.

Argument	Location	Type	Default
path	query/framework-specific	str	''

Explicit handler errors:

HTTPException(status_code=404, detail='TTS path not found.')

Request template (uses configured service base URL):

curl --fail-with-body "$SERVICE_URL/api/tts/files"

GET /api/asr/files

Handler: asr_files. Source: head-ros-nodes/ros/webui/api/webui_api/main.py:479. Behavior and examples.

Argument	Location	Type	Default
path	query/framework-specific	str	''

Explicit handler errors:

HTTPException(status_code=404, detail='ASR path not found.')

Request template (uses configured service base URL):

curl --fail-with-body "$SERVICE_URL/api/asr/files"

GET/POST/PUT/PATCH/DELETE /api/{path:path}

Handler: unknown_api_route. Source: head-ros-nodes/ros/webui/api/webui_api/main.py:489. Behavior and examples.

Argument	Location	Type	Default
path	path	str	required

Explicit handler errors:

HTTPException(status_code=404, detail=f'Unknown API route: /api/{path}')

GET /monitor/status

Handler: legacy_monitor_status. Source: head-ros-nodes/ros/webui/api/webui_api/main.py:493. Behavior and examples.

No explicit handler arguments beyond framework state.

Direct source delegates (static trace):

• monitor_status in head-ros-nodes/ros/webui/api/webui_api/adapters/ros2.py:559

GET /robot_config_schema

Handler: legacy_robot_config_schema. Source: head-ros-nodes/ros/webui/api/webui_api/main.py:497. Behavior and examples.

No explicit handler arguments beyond framework state.

GET /robot_config/{name}

Handler: legacy_robot_config. Source: head-ros-nodes/ros/webui/api/webui_api/main.py:502. Behavior and examples.

Argument	Location	Type	Default
name	path	str	required

GET /motors/get/{name}

Handler: legacy_motors. Source: head-ros-nodes/ros/webui/api/webui_api/main.py:507. Behavior and examples.

Argument	Location	Type	Default
name	path	str	required

Direct source delegates (static trace):

• list_motors in head-ros-nodes/ros/webui/api/webui_api/adapters/ros2.py:569

GET /attention_regions/{name}

Handler: removed_legacy_attention_regions. Source: head-ros-nodes/ros/webui/api/webui_api/main.py:513. Behavior and examples.

Argument	Location	Type	Default
name	path	str	required

Explicit handler errors:

HTTPException(status_code=404, detail='Attention regions are removed from the API.')

WEBSOCKET /ws

Handler: websocket_endpoint. Source: head-ros-nodes/ros/webui/api/webui_api/main.py:517. Behavior and examples.

No explicit handler arguments beyond framework state.

Observed dictionary fields (including directly traced delegate methods):

Object	Field	Lookup default
message	action	None
message	agentId	None
message	commandId	None
message	enabled	None
message	key	None
message	language	None
message	mode	None
message	options	{}
message	pose	None
message	requestId	None
message	situation	None
message	state	None
message	type	None
message	value	None
message	voice	None

Direct source delegates (static trace):

• performance_runtime in head-ros-nodes/ros/webui/api/webui_api/adapters/ros2.py:1962
• runtime_settings in head-ros-nodes/ros/webui/api/webui_api/adapters/ros2.py:472
• handle_command in head-ros-nodes/ros/webui/api/webui_api/adapters/ros2.py:718

WEBSOCKET /ws/audio

Handler: audio_websocket_endpoint. Source: head-ros-nodes/ros/webui/api/webui_api/main.py:590. Behavior and examples.

No explicit handler arguments beyond framework state.

GET /tts

Handler: tts_root. Source: head-ros-nodes/ros/webui/api/webui_api/main.py:611. Behavior and examples.

No explicit handler arguments beyond framework state.

GET /tts/

Handler: tts_root. Source: head-ros-nodes/ros/webui/api/webui_api/main.py:611. Behavior and examples.

No explicit handler arguments beyond framework state.

GET /tts/{path:path}

Handler: tts_file. Source: head-ros-nodes/ros/webui/api/webui_api/main.py:615. Behavior and examples.

Argument	Location	Type	Default
path	path	str	required

GET /asr

Handler: asr_root. Source: head-ros-nodes/ros/webui/api/webui_api/main.py:628. Behavior and examples.

No explicit handler arguments beyond framework state.

GET /asr/

Handler: asr_root. Source: head-ros-nodes/ros/webui/api/webui_api/main.py:628. Behavior and examples.

No explicit handler arguments beyond framework state.

GET /asr/{path:path}

Handler: asr_file. Source: head-ros-nodes/ros/webui/api/webui_api/main.py:632. Behavior and examples.

Argument	Location	Type	Default
path	path	str	required

GET /

Handler: index. Source: head-ros-nodes/ros/webui/api/webui_api/main.py:649. Behavior and examples.

No explicit handler arguments beyond framework state.

GET /{path:path}

Handler: spa_fallback. Source: head-ros-nodes/ros/webui/api/webui_api/main.py:655. Behavior and examples.

Argument	Location	Type	Default
path	path	str	required