Skip to content

Documentation coverage and verification

Coverage below verifies that discovered source surfaces are connected to both references and behavior guides. It does not equate a generated signature with a complete validated client contract or a live hardware test. Source-derived behavior must be matched to the deployed version.

HTTP and WebSocket declarations

Service Method/path Source reference Behavior guide
System console GET /api/health Declaration / Parameters Guide
System console GET /api/system/summary Declaration / Parameters Guide
System console GET /api/system/resources Declaration / Parameters Guide
System console GET /api/system/services Declaration / Parameters Guide
System console GET /api/settings/rustdesk Declaration / Parameters Guide
System console GET /api/settings/system-console/update Declaration / Parameters Guide
System console POST /api/settings/rustdesk/install Declaration / Parameters Guide
System console POST /api/settings/rustdesk/password Declaration / Parameters Guide
System console POST /api/settings/rustdesk/virtual-display Declaration / Parameters Guide
System console GET /api/system/services/{unit}/logs Declaration / Parameters Guide
System console GET /api/hrsdk/summary Declaration / Parameters Guide
System console GET /api/setup/status Declaration / Parameters Guide
System console GET /api/setup/preflight Declaration / Parameters Guide
System console GET /api/setup/logs Declaration / Parameters Guide
System console POST /api/setup/draft Declaration / Parameters Guide
System console POST /api/setup/credentials/validate Declaration / Parameters Guide
System console GET /api/releases Declaration / Parameters Guide
System console POST /api/setup/install Declaration / Parameters Guide
System console POST /api/releases/switch Declaration / Parameters Guide
System console GET /api/hrsdk/config Declaration / Parameters Guide
System console GET /api/hrsdk/runtime-secrets Declaration / Parameters Guide
System console PATCH /api/hrsdk/runtime-secrets Declaration / Parameters Guide
System console POST /api/hrsdk/config Declaration / Parameters Guide
System console GET /api/hrsdk/containers Declaration / Parameters Guide
System console POST /api/hrsdk/containers/update Declaration / Parameters Guide
System console POST /api/hrsdk/containers/update-one Declaration / Parameters Guide
System console GET /api/hrsdk/configs Declaration / Parameters Guide
System console POST /api/hrsdk/configs/pull Declaration / Parameters Guide
System console GET /api/hrsdk/servos Declaration / Parameters Guide
System console GET /api/servos/ports Declaration / Parameters Guide
System console GET /api/servos/configuration Declaration / Parameters Guide
System console POST /api/servos/configuration Declaration / Parameters Guide
System console POST /api/servos/scan Declaration / Parameters Guide
System console POST /api/servos/registers Declaration / Parameters Guide
System console POST /api/servos/registers/write Declaration / Parameters Guide
System console POST /api/servos/reset-neutral Declaration / Parameters Guide
System console POST /api/servos/move Declaration / Parameters Guide
System console POST /api/services/{unit}/start Declaration / Parameters Guide
System console POST /api/services/{unit}/stop Declaration / Parameters Guide
System console POST /api/services/{unit}/restart Declaration / Parameters Guide
System console GET /api/network/adapters Declaration / Parameters Guide
System console GET /api/network/routes Declaration / Parameters Guide
System console GET /api/network/internet Declaration / Parameters Guide
System console GET /api/network/internet-sharing/status Declaration / Parameters Guide
System console GET /api/network/wifi Declaration / Parameters Guide
System console GET /api/network/ethernet Declaration / Parameters Guide
System console POST /api/network/ethernet/device Declaration / Parameters Guide
System console POST /api/network/ethernet/apply Declaration / Parameters Guide
System console POST /api/network/ethernet/confirm Declaration / Parameters Guide
System console POST /api/network/ethernet/rollback Declaration / Parameters Guide
System console GET /api/network/ethernet/{device}/test Declaration / Parameters Guide
System console POST /api/network/wifi/connect Declaration / Parameters Guide
System console POST /api/network/wifi/forget Declaration / Parameters Guide
System console POST /api/network/wifi/disconnect Declaration / Parameters Guide
System console POST /api/network/wifi/rescan Declaration / Parameters Guide
System console POST /api/network/internet-sharing/enable Declaration / Parameters Guide
System console POST /api/network/internet-sharing/disable Declaration / Parameters Guide
System console GET /api/audio/devices Declaration / Parameters Guide
System console GET /api/audio/levels Declaration / Parameters Guide
System console POST /api/audio/default-device Declaration / Parameters Guide
System console POST /api/audio/output-choice Declaration / Parameters Guide
System console POST /api/audio/input-choice Declaration / Parameters Guide
System console POST /api/audio/volume Declaration / Parameters Guide
System console POST /api/audio/channel-map Declaration / Parameters Guide
System console GET /api/audio/routing Declaration / Parameters Guide
System console POST /api/audio/routing/apply Declaration / Parameters Guide
System console POST /api/audio/routing/preset Declaration / Parameters Guide
System console POST /api/audio/routing/test-tone Declaration / Parameters Guide
System console POST /api/audio/routing/reset Declaration / Parameters Guide
System console GET /api/audio/routing/container-check Declaration / Parameters Guide
System console GET /api/usb/tree Declaration / Parameters Guide
System console GET /api/jetson/status Declaration / Parameters Guide
System console POST /api/jetson/perception/restart Declaration / Parameters Guide
System console POST /api/jetson/provision Declaration / Parameters Guide
System console POST /api/jetson/update Declaration / Parameters Guide
System console GET /api/tasks/{task_id} Declaration / Parameters Guide
System console WEBSOCKET /ws Declaration / Parameters Guide
System console GET / Declaration / Parameters Guide
System console GET /{path:path} Declaration / Parameters Guide
Robot WebUI GET /api/robot/config Declaration / Parameters Guide
Robot WebUI GET /api/robot/config/schema Declaration / Parameters Guide
Robot WebUI GET /api/robot/config/{name} Declaration / Parameters Guide
Robot WebUI POST /api/robot/config/{name} Declaration / Parameters Guide
Robot WebUI GET /api/virtual-project Declaration / Parameters Guide
Robot WebUI GET /api/settings/nodes Declaration / Parameters Guide
Robot WebUI GET /api/settings/nodes/{node_name:path}/description Declaration / Parameters Guide
Robot WebUI GET /api/settings/nodes/{node_name:path}/configuration Declaration / Parameters Guide
Robot WebUI POST /api/settings/nodes/{node_name:path}/configuration Declaration / Parameters Guide
Robot WebUI POST /api/settings/nodes/{node_name:path}/save Declaration / Parameters Guide
Robot WebUI POST /api/settings/nodes/{node_name:path}/reset Declaration / Parameters Guide
Robot WebUI GET /api/settings/nodes/{node_name:path}/saved-file Declaration / Parameters Guide
Robot WebUI DELETE /api/settings/nodes/{node_name:path}/saved-file Declaration / Parameters Guide
Robot WebUI GET /api/settings/suggestions Declaration / Parameters Guide
Robot WebUI GET /api/monitor/status Declaration / Parameters Guide
Robot WebUI GET /api/faces Declaration / Parameters Guide
Robot WebUI GET /api/faces/recognition-settings Declaration / Parameters Guide
Robot WebUI POST /api/faces/recognition-settings Declaration / Parameters Guide
Robot WebUI POST /api/faces Declaration / Parameters Guide
Robot WebUI DELETE /api/faces/{face_id} Declaration / Parameters Guide
Robot WebUI GET /api/faces/images/{image_path:path} Declaration / Parameters Guide
Robot WebUI POST /api/faces/{face_id}/images Declaration / Parameters Guide
Robot WebUI POST /api/faces/{face_id}/regenerate Declaration / Parameters Guide
Robot WebUI POST /api/faces/regenerate Declaration / Parameters Guide
Robot WebUI POST /api/faces/search Declaration / Parameters Guide
Robot WebUI GET /api/faces/live-candidates Declaration / Parameters Guide
Robot WebUI GET /api/teleops/state Declaration / Parameters Guide
Robot WebUI GET /api/teleops/catalog Declaration / Parameters Guide
Robot WebUI GET /api/teleops/settings Declaration / Parameters Guide
Robot WebUI POST /api/teleops/command Declaration / Parameters Guide
Robot WebUI POST /api/settings/trees/{tree_name:path} Declaration / Parameters Guide
Robot WebUI GET /api/settings/trees/{tree_name:path} Declaration / Parameters Guide
Robot WebUI DELETE /api/settings/trees/{tree_name:path} Declaration / Parameters Guide
Robot WebUI GET /api/motors Declaration / Parameters Guide
Robot WebUI GET /api/motors/states Declaration / Parameters Guide
Robot WebUI POST /api/motors/control Declaration / Parameters Guide
Robot WebUI POST /api/motors/command Declaration / Parameters Guide
Robot WebUI POST /api/motors/torque Declaration / Parameters Guide
Robot WebUI GET /api/motors/config Declaration / Parameters Guide
Robot WebUI POST /api/motors/config Declaration / Parameters Guide
Robot WebUI GET /api/navigation/locations Declaration / Parameters Guide
Robot WebUI POST /api/navigation/go-to Declaration / Parameters Guide
Robot WebUI POST /api/navigation/go-to-position Declaration / Parameters Guide
Robot WebUI POST /api/navigation/stop Declaration / Parameters Guide
Robot WebUI GET /api/performances Declaration / Parameters Guide
Robot WebUI GET /api/performances/current Declaration / Parameters Guide
Robot WebUI GET /api/performances/{item_path:path} Declaration / Parameters Guide
Robot WebUI POST /api/performances/{item_path:path} Declaration / Parameters Guide
Robot WebUI DELETE /api/performances/{item_path:path} Declaration / Parameters Guide
Robot WebUI POST /api/performance-folders/{folder_path:path} Declaration / Parameters Guide
Robot WebUI POST /api/performance-move/{item_path:path} Declaration / Parameters Guide
Robot WebUI GET /api/performance-properties Declaration / Parameters Guide
Robot WebUI GET /api/performance-properties/{property_path:path} Declaration / Parameters Guide
Robot WebUI POST /api/performance-properties/{property_path:path} Declaration / Parameters Guide
Robot WebUI GET /api/performance-catalog Declaration / Parameters Guide
Robot WebUI POST /api/performance-runtime/speech-length Declaration / Parameters Guide
Robot WebUI POST /api/performance-runtime/animation-length Declaration / Parameters Guide
Robot WebUI POST /api/performance-runtime/arm-animation-length Declaration / Parameters Guide
Robot WebUI POST /api/performance-runtime/tts-preview Declaration / Parameters Guide
Robot WebUI POST /api/performance-runtime/preview Declaration / Parameters Guide
Robot WebUI GET /api/performance-runtime/autopause Declaration / Parameters Guide
Robot WebUI GET /api/compat/legacy-routes Declaration / Parameters Guide
Robot WebUI GET /api/health Declaration / Parameters Guide
Robot WebUI GET /api/version Declaration / Parameters Guide
Robot WebUI GET /api/status Declaration / Parameters Guide
Robot WebUI GET /api/video/fov.mjpg Declaration / Parameters Guide
Robot WebUI GET /api/video/fov.jpg Declaration / Parameters Guide
Robot WebUI GET /api/tts/files Declaration / Parameters Guide
Robot WebUI GET /api/asr/files Declaration / Parameters Guide
Robot WebUI GET/POST/PUT/PATCH/DELETE /api/{path:path} Declaration / Parameters Guide
Robot WebUI GET /monitor/status Declaration / Parameters Guide
Robot WebUI GET /robot_config_schema Declaration / Parameters Guide
Robot WebUI GET /robot_config/{name} Declaration / Parameters Guide
Robot WebUI GET /motors/get/{name} Declaration / Parameters Guide
Robot WebUI GET /attention_regions/{name} Declaration / Parameters Guide
Robot WebUI WEBSOCKET /ws Declaration / Parameters Guide
Robot WebUI WEBSOCKET /ws/audio Declaration / Parameters Guide
Robot WebUI GET /tts Declaration / Parameters Guide
Robot WebUI GET /tts/ Declaration / Parameters Guide
Robot WebUI GET /tts/{path:path} Declaration / Parameters Guide
Robot WebUI GET /asr Declaration / Parameters Guide
Robot WebUI GET /asr/ Declaration / Parameters Guide
Robot WebUI GET /asr/{path:path} Declaration / Parameters Guide
Robot WebUI GET / Declaration / Parameters Guide
Robot WebUI GET /{path:path} Declaration / Parameters Guide
TTS GET /<vendor> Declaration / Parameters Guide
TTS GET /ping Declaration / Parameters Guide

Additional current network surfaces

Surface Guide
Tool bridge POST /tools/call Tool bridge
Audio helper GET /status and helper assets Audio bridge
Unity animation WebSocket Unity
FastAPI schema/documentation routes Network map
ROS registrations, service/message definitions ROS references
Redis/configuration client APIs Configuration

User-interface source coverage

Application/page Workflow guide
hr_system_console/AudioPage Workflow
hr_system_console/DevicesPage Workflow
hr_system_console/HrsdkPage Workflow
hr_system_console/HrsdkSetup Workflow
hr_system_console/JetsonPage Workflow
hr_system_console/LogsPage Workflow
hr_system_console/NetworkPage Workflow
hr_system_console/OverviewPage Workflow
hr_system_console/ServoPage Workflow
hr_system_console/SettingsPage Workflow
head-ros-nodes/ASRFilesPage Workflow
head-ros-nodes/FacesPage Workflow
head-ros-nodes/MotorsPage Workflow
head-ros-nodes/PerformancesPage Workflow
head-ros-nodes/SettingsPage Workflow
head-ros-nodes/TTSFilesPage Workflow
head-ros-nodes/TeleOpsPage Workflow
head-ros-nodes/VisualizationPage Workflow

Verification boundaries

  • Strict build and generated HTML link/anchor checks establish website consistency.
  • Route/model/ROS/CLI indexes are extracted without starting robot services.
  • Guides describe inspected source. Working-branch differences from installed releases remain explicit.
  • Hardware movement, torque/register changes, live provider calls, microphone capture, Jetson camera/GPU and robot update/restore procedures were not executed while authoring.
  • Public hosting, browser checks and release rollback are verified separately in the deployment record.