System console: 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/health

Handler: health. Source: hr_system_console/api/system_console/main.py:387. Behavior and examples.

No explicit handler arguments beyond framework state.

Request template (uses configured service base URL):

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

GET /api/system/summary

Handler: system_summary. Source: hr_system_console/api/system_console/main.py:398. Behavior and examples.

No explicit handler arguments beyond framework state.

Request template (uses configured service base URL):

curl --fail-with-body "$SERVICE_URL/api/system/summary"

GET /api/system/resources

Handler: system_resources. Source: hr_system_console/api/system_console/main.py:414. Behavior and examples.

No explicit handler arguments beyond framework state.

Request template (uses configured service base URL):

curl --fail-with-body "$SERVICE_URL/api/system/resources"

GET /api/system/services

Handler: system_services. Source: hr_system_console/api/system_console/main.py:418. Behavior and examples.

No explicit handler arguments beyond framework state.

Request template (uses configured service base URL):

curl --fail-with-body "$SERVICE_URL/api/system/services"

GET /api/settings/rustdesk

Handler: rustdesk_status. Source: hr_system_console/api/system_console/main.py:422. Behavior and examples.

No explicit handler arguments beyond framework state.

Request template (uses configured service base URL):

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

GET /api/settings/system-console/update

Handler: system_console_update. Source: hr_system_console/api/system_console/main.py:426. Behavior and examples.

No explicit handler arguments beyond framework state.

Request template (uses configured service base URL):

curl --fail-with-body "$SERVICE_URL/api/settings/system-console/update"

POST /api/settings/rustdesk/install

Handler: rustdesk_install. Source: hr_system_console/api/system_console/main.py:430. Behavior and examples.

Argument	Location	Type	Default
payload	JSON body/model	RustdeskPasswordPayload	required

Background task labels: 'Install and configure RustDesk'. Follow task completion; the initial response is not completion.

Direct source delegates (static trace):

• validate_password in hr_system_console/api/system_console/services/rustdesk.py:132
• install in hr_system_console/api/system_console/services/rustdesk.py:205

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/settings/rustdesk/password

Handler: rustdesk_password. Source: hr_system_console/api/system_console/main.py:438. Behavior and examples.

Argument	Location	Type	Default
payload	JSON body/model	RustdeskPasswordPayload	required

Background task labels: 'Change RustDesk password'. Follow task completion; the initial response is not completion.

Direct source delegates (static trace):

• validate_password in hr_system_console/api/system_console/services/rustdesk.py:132
• set_password in hr_system_console/api/system_console/services/rustdesk.py:240

Explicit handler errors:

ValueError('RustDesk is not installed')
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/settings/rustdesk/virtual-display

Handler: rustdesk_virtual_display. Source: hr_system_console/api/system_console/main.py:449. Behavior and examples.

Argument	Location	Type	Default
payload	JSON body/model	RustdeskVirtualDisplayPayload	required

Background task labels: f'{action} RustDesk virtual display'. Follow task completion; the initial response is not completion.

Direct source delegates (static trace):

• set_virtual_display in hr_system_console/api/system_console/services/rustdesk.py:251

Explicit handler errors:

ValueError('RustDesk is not installed')
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/system/services/{unit}/logs

Handler: service_logs. Source: hr_system_console/api/system_console/main.py:463. Behavior and examples.

Argument	Location	Type	Default
unit	path	str	required
lines	query/framework-specific	int	120

Direct source delegates (static trace):

• service_logs in hr_system_console/api/system_console/services/system.py:103

Explicit handler errors:

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

GET /api/hrsdk/summary

Handler: hrsdk_summary. Source: hr_system_console/api/system_console/main.py:470. Behavior and examples.

Argument	Location	Type	Default
checkUpdates	query/framework-specific	bool	False
fetchConfigs	query/framework-specific	bool	False

Request template (uses configured service base URL):

curl --fail-with-body "$SERVICE_URL/api/hrsdk/summary"

GET /api/setup/status

Handler: setup_status. Source: hr_system_console/api/system_console/main.py:485. Behavior and examples.

No explicit handler arguments beyond framework state.

Request template (uses configured service base URL):

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

GET /api/setup/preflight

Handler: setup_preflight. Source: hr_system_console/api/system_console/main.py:489. Behavior and examples.

No explicit handler arguments beyond framework state.

Request template (uses configured service base URL):

curl --fail-with-body "$SERVICE_URL/api/setup/preflight"

GET /api/setup/logs

Handler: setup_logs. Source: hr_system_console/api/system_console/main.py:493. Behavior and examples.

No explicit handler arguments beyond framework state.

Request template (uses configured service base URL):

curl --fail-with-body "$SERVICE_URL/api/setup/logs"

POST /api/setup/draft

Handler: setup_draft. Source: hr_system_console/api/system_console/main.py:497. Behavior and examples.

Argument	Location	Type	Default
payload	JSON body/model	SetupPayload	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/setup/credentials/validate

Handler: setup_credentials_validate. Source: hr_system_console/api/system_console/main.py:501. Behavior and examples.

Argument	Location	Type	Default
payload	JSON body/model	SetupPayload	required

Explicit handler errors:

HTTPException(status_code=400, detail=result)

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/releases

Handler: releases. Source: hr_system_console/api/system_console/main.py:508. Behavior and examples.

No explicit handler arguments beyond framework state.

Request template (uses configured service base URL):

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

POST /api/setup/install

Handler: setup_install. Source: hr_system_console/api/system_console/main.py:512. Behavior and examples.

Argument	Location	Type	Default
payload	JSON body/model	SetupPayload	required

Background task labels: 'Install HRSDK'. Follow task completion; the initial response is not completion.

Direct source delegates (static trace):

• install in hr_system_console/api/system_console/setup.py:979

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/releases/switch

Handler: release_switch. Source: hr_system_console/api/system_console/main.py:516. Behavior and examples.

Argument	Location	Type	Default
payload	JSON body/model	ReleasePayload	required

Background task labels: f'Switch SDK to {payload.version}'. Follow task completion; the initial response is not completion.

Direct source delegates (static trace):

• switch_release in hr_system_console/api/system_console/setup.py:1418

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/hrsdk/config

Handler: hrsdk_config. Source: hr_system_console/api/system_console/main.py:520. Behavior and examples.

No explicit handler arguments beyond framework state.

Request template (uses configured service base URL):

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

GET /api/hrsdk/runtime-secrets

Handler: hrsdk_runtime_secrets. Source: hr_system_console/api/system_console/main.py:524. Behavior and examples.

No explicit handler arguments beyond framework state.

Request template (uses configured service base URL):

curl --fail-with-body "$SERVICE_URL/api/hrsdk/runtime-secrets"

PATCH /api/hrsdk/runtime-secrets

Handler: hrsdk_runtime_secrets_update. Source: hr_system_console/api/system_console/main.py:528. Behavior and examples.

Argument	Location	Type	Default
payload	JSON body/model	RuntimeSecretsPayload	required

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/hrsdk/config

Handler: hrsdk_config_update. Source: hr_system_console/api/system_console/main.py:539. Behavior and examples.

Argument	Location	Type	Default
payload	JSON body/model	HrsdkConfigPayload	required

Direct source delegates (static trace):

• update_config in hr_system_console/api/system_console/services/hrsdk.py:224

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/hrsdk/containers

Handler: hrsdk_containers. Source: hr_system_console/api/system_console/main.py:548. Behavior and examples.

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

Request template (uses configured service base URL):

curl --fail-with-body "$SERVICE_URL/api/hrsdk/containers"

POST /api/hrsdk/containers/update

Handler: hrsdk_containers_update. Source: hr_system_console/api/system_console/main.py:554. Behavior and examples.

No explicit handler arguments beyond framework state.

Background task labels: 'Update HRSDK containers'. Follow task completion; the initial response is not completion.

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/hrsdk/containers/update-one

Handler: hrsdk_container_update. Source: hr_system_console/api/system_console/main.py:558. Behavior and examples.

Argument	Location	Type	Default
payload	JSON body/model	HrsdkContainerPayload	required

Background task labels: f'Update {payload.repository}'. Follow task completion; the initial response is not completion.

Direct source delegates (static trace):

• update_container in hr_system_console/api/system_console/services/hrsdk.py:654

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/hrsdk/configs

Handler: hrsdk_configs. Source: hr_system_console/api/system_console/main.py:562. Behavior and examples.

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

Request template (uses configured service base URL):

curl --fail-with-body "$SERVICE_URL/api/hrsdk/configs"

POST /api/hrsdk/configs/pull

Handler: hrsdk_configs_pull. Source: hr_system_console/api/system_console/main.py:568. Behavior and examples.

No explicit handler arguments beyond framework state.

Background task labels: 'Pull hrsdk_configs'. Follow task completion; the initial response is not completion.

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/hrsdk/servos

Handler: hrsdk_servos. Source: hr_system_console/api/system_console/main.py:572. Behavior and examples.

Argument	Location	Type	Default
scan	query/framework-specific	bool	True

Request template (uses configured service base URL):

curl --fail-with-body "$SERVICE_URL/api/hrsdk/servos"

GET /api/servos/ports

Handler: servo_ports. Source: hr_system_console/api/system_console/main.py:579. Behavior and examples.

No explicit handler arguments beyond framework state.

Request template (uses configured service base URL):

curl --fail-with-body "$SERVICE_URL/api/servos/ports"

GET /api/servos/configuration

Handler: servo_configuration. Source: hr_system_console/api/system_console/main.py:587. Behavior and examples.

No explicit handler arguments beyond framework state.

Request template (uses configured service base URL):

curl --fail-with-body "$SERVICE_URL/api/servos/configuration"

POST /api/servos/configuration

Handler: servo_configuration_select. Source: hr_system_console/api/system_console/main.py:591. Behavior and examples.

Argument	Location	Type	Default
payload	JSON body/model	ServoConfigPayload	required

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/servos/scan

Handler: servo_scan. Source: hr_system_console/api/system_console/main.py:598. Behavior and examples.

Argument	Location	Type	Default
payload	JSON body/model	ServoScanPayload	required

Explicit handler errors:

HTTPException(status_code=400, detail=str(error))
HTTPException(status_code=503, 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/servos/registers

Handler: servo_registers. Source: hr_system_console/api/system_console/main.py:607. Behavior and examples.

Argument	Location	Type	Default
payload	JSON body/model	ServoTargetPayload	required

Explicit handler errors:

HTTPException(status_code=400, detail=str(error))
HTTPException(status_code=503, 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/servos/registers/write

Handler: servo_register_write. Source: hr_system_console/api/system_console/main.py:616. Behavior and examples.

Argument	Location	Type	Default
payload	JSON body/model	ServoWritePayload	required

Explicit handler errors:

HTTPException(status_code=400, detail=str(error))
HTTPException(status_code=503, 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/servos/reset-neutral

Handler: servo_reset_neutral. Source: hr_system_console/api/system_console/main.py:625. Behavior and examples.

Argument	Location	Type	Default
payload	JSON body/model	ServoTargetPayload	required

Explicit handler errors:

HTTPException(status_code=400, detail=str(error))
HTTPException(status_code=503, 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/servos/move

Handler: servo_move. Source: hr_system_console/api/system_console/main.py:634. Behavior and examples.

Argument	Location	Type	Default
payload	JSON body/model	ServoMovePayload	required

Explicit handler errors:

HTTPException(status_code=400, detail=str(error))
HTTPException(status_code=503, 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/services/{unit}/start

Handler: service_start. Source: hr_system_console/api/system_console/main.py:666. Behavior and examples.

Argument	Location	Type	Default
unit	path	str	required

Background task labels: f'Start {unit}'. Follow task completion; the initial response is not completion.

Direct source delegates (static trace):

• control_service in hr_system_console/api/system_console/services/system.py:95

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/services/{unit}/stop

Handler: service_stop. Source: hr_system_console/api/system_console/main.py:670. Behavior and examples.

Argument	Location	Type	Default
unit	path	str	required

Background task labels: f'Stop {unit}'. Follow task completion; the initial response is not completion.

Direct source delegates (static trace):

• control_service in hr_system_console/api/system_console/services/system.py:95

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/services/{unit}/restart

Handler: service_restart. Source: hr_system_console/api/system_console/main.py:674. Behavior and examples.

Argument	Location	Type	Default
unit	path	str	required

Background task labels: f'Restart {unit}'. Follow task completion; the initial response is not completion.

Direct source delegates (static trace):

• mark_runtime_secrets_applied in hr_system_console/api/system_console/setup.py:525
• control_service in hr_system_console/api/system_console/services/system.py:95

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/network/adapters

Handler: network_adapters. Source: hr_system_console/api/system_console/main.py:683. Behavior and examples.

No explicit handler arguments beyond framework state.

Request template (uses configured service base URL):

curl --fail-with-body "$SERVICE_URL/api/network/adapters"

GET /api/network/routes

Handler: network_routes. Source: hr_system_console/api/system_console/main.py:687. Behavior and examples.

No explicit handler arguments beyond framework state.

Request template (uses configured service base URL):

curl --fail-with-body "$SERVICE_URL/api/network/routes"

GET /api/network/internet

Handler: network_internet. Source: hr_system_console/api/system_console/main.py:691. Behavior and examples.

No explicit handler arguments beyond framework state.

Request template (uses configured service base URL):

curl --fail-with-body "$SERVICE_URL/api/network/internet"

GET /api/network/internet-sharing/status

Handler: internet_sharing_status. Source: hr_system_console/api/system_console/main.py:701. Behavior and examples.

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

Request template (uses configured service base URL):

curl --fail-with-body "$SERVICE_URL/api/network/internet-sharing/status"

GET /api/network/wifi

Handler: network_wifi. Source: hr_system_console/api/system_console/main.py:707. Behavior and examples.

No explicit handler arguments beyond framework state.

Request template (uses configured service base URL):

curl --fail-with-body "$SERVICE_URL/api/network/wifi"

GET /api/network/ethernet

Handler: network_ethernet. Source: hr_system_console/api/system_console/main.py:711. Behavior and examples.

No explicit handler arguments beyond framework state.

Request template (uses configured service base URL):

curl --fail-with-body "$SERVICE_URL/api/network/ethernet"

POST /api/network/ethernet/device

Handler: network_ethernet_device. Source: hr_system_console/api/system_console/main.py:715. Behavior and examples.

Argument	Location	Type	Default
payload	JSON body/model	EthernetDevicePayload	required

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/network/ethernet/apply

Handler: network_ethernet_apply. Source: hr_system_console/api/system_console/main.py:724. Behavior and examples.

Argument	Location	Type	Default
payload	JSON body/model	EthernetPayload	required

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/network/ethernet/confirm

Handler: network_ethernet_confirm. Source: hr_system_console/api/system_console/main.py:733. Behavior and examples.

Argument	Location	Type	Default
payload	JSON body/model	EthernetTokenPayload	required

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/network/ethernet/rollback

Handler: network_ethernet_rollback. Source: hr_system_console/api/system_console/main.py:740. Behavior and examples.

Argument	Location	Type	Default
payload	JSON body/model	EthernetTokenPayload	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/network/ethernet/{device}/test

Handler: network_ethernet_test. Source: hr_system_console/api/system_console/main.py:744. Behavior and examples.

Argument	Location	Type	Default
device	path	str	required

Explicit handler errors:

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

POST /api/network/wifi/connect

Handler: network_wifi_connect. Source: hr_system_console/api/system_console/main.py:751. Behavior and examples.

Argument	Location	Type	Default
payload	JSON body/model	WifiConnectPayload	required

Background task labels: f'Connect Wi-Fi {payload.ssid}'. Follow task completion; the initial response is not completion.

Direct source delegates (static trace):

• connect_wifi in hr_system_console/api/system_console/services/network.py:201

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/network/wifi/forget

Handler: network_wifi_forget. Source: hr_system_console/api/system_console/main.py:755. Behavior and examples.

Argument	Location	Type	Default
payload	JSON body/model	WifiForgetPayload	required

Background task labels: f'Forget Wi-Fi {payload.ssid}'. Follow task completion; the initial response is not completion.

Direct source delegates (static trace):

• forget_wifi in hr_system_console/api/system_console/services/network.py:221

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/network/wifi/disconnect

Handler: network_wifi_disconnect. Source: hr_system_console/api/system_console/main.py:759. Behavior and examples.

Argument	Location	Type	Default
payload	JSON body/model	WifiDisconnectPayload	required

Background task labels: 'Disconnect Wi-Fi'. Follow task completion; the initial response is not completion.

Direct source delegates (static trace):

• disconnect_wifi in hr_system_console/api/system_console/services/network.py:214

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/network/wifi/rescan

Handler: network_wifi_rescan. Source: hr_system_console/api/system_console/main.py:763. 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/network/internet-sharing/enable

Handler: internet_sharing_enable. Source: hr_system_console/api/system_console/main.py:768. Behavior and examples.

Argument	Location	Type	Default
payload	JSON body/model	InternetSharingPayload	required

Background task labels: 'Enable internet sharing'. Follow task completion; the initial response is not completion.

Direct source delegates (static trace):

• set_internet_sharing in hr_system_console/api/system_console/services/network.py:473

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/network/internet-sharing/disable

Handler: internet_sharing_disable. Source: hr_system_console/api/system_console/main.py:772. Behavior and examples.

Argument	Location	Type	Default
payload	JSON body/model	InternetSharingPayload	required

Background task labels: 'Disable internet sharing'. Follow task completion; the initial response is not completion.

Direct source delegates (static trace):

• set_internet_sharing in hr_system_console/api/system_console/services/network.py:473

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/audio/devices

Handler: audio_devices. Source: hr_system_console/api/system_console/main.py:776. Behavior and examples.

No explicit handler arguments beyond framework state.

Request template (uses configured service base URL):

curl --fail-with-body "$SERVICE_URL/api/audio/devices"

GET /api/audio/levels

Handler: audio_levels. Source: hr_system_console/api/system_console/main.py:780. Behavior and examples.

No explicit handler arguments beyond framework state.

Request template (uses configured service base URL):

curl --fail-with-body "$SERVICE_URL/api/audio/levels"

POST /api/audio/default-device

Handler: audio_default_device. Source: hr_system_console/api/system_console/main.py:784. Behavior and examples.

Argument	Location	Type	Default
payload	JSON body/model	DefaultAudioPayload	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/audio/output-choice

Handler: audio_output_choice. Source: hr_system_console/api/system_console/main.py:790. Behavior and examples.

Argument	Location	Type	Default
payload	JSON body/model	AudioChoicePayload	required

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/audio/input-choice

Handler: audio_input_choice. Source: hr_system_console/api/system_console/main.py:799. Behavior and examples.

Argument	Location	Type	Default
payload	JSON body/model	AudioChoicePayload	required

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/audio/volume

Handler: audio_volume. Source: hr_system_console/api/system_console/main.py:808. Behavior and examples.

Argument	Location	Type	Default
payload	JSON body/model	VolumePayload	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/audio/channel-map

Handler: audio_channel_map. Source: hr_system_console/api/system_console/main.py:814. Behavior and examples.

Argument	Location	Type	Default
payload	JSON body/model	ChannelMapPayload	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/audio/routing

Handler: audio_routing. Source: hr_system_console/api/system_console/main.py:820. Behavior and examples.

No explicit handler arguments beyond framework state.

Request template (uses configured service base URL):

curl --fail-with-body "$SERVICE_URL/api/audio/routing"

POST /api/audio/routing/apply

Handler: audio_routing_apply. Source: hr_system_console/api/system_console/main.py:824. Behavior and examples.

Argument	Location	Type	Default
payload	JSON body/model	RoutingApplyPayload	required

Background task labels: 'Apply audio routing'. Follow task completion; the initial response is not completion.

Direct source delegates (static trace):

• apply_routing in hr_system_console/api/system_console/services/audio.py:271

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/audio/routing/preset

Handler: audio_routing_preset. Source: hr_system_console/api/system_console/main.py:833. Behavior and examples.

Argument	Location	Type	Default
payload	JSON body/model	RoutingPresetPayload	required

Background task labels: 'Apply audio routing preset'. Follow task completion; the initial response is not completion.

Direct source delegates (static trace):

• apply_routing_preset in hr_system_console/api/system_console/services/audio.py:319

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/audio/routing/test-tone

Handler: audio_routing_test_tone. Source: hr_system_console/api/system_console/main.py:837. Behavior and examples.

Argument	Location	Type	Default
payload	JSON body/model	RoutingTonePayload	required

Background task labels: 'Play audio routing test tone'. Follow task completion; the initial response is not completion.

Direct source delegates (static trace):

• test_routing_tone in hr_system_console/api/system_console/services/audio.py:390

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/audio/routing/reset

Handler: audio_routing_reset. Source: hr_system_console/api/system_console/main.py:841. Behavior and examples.

No explicit handler arguments beyond framework state.

Background task labels: 'Reset audio routing'. Follow task completion; the initial response is not completion.

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/audio/routing/container-check

Handler: audio_routing_container_check. Source: hr_system_console/api/system_console/main.py:845. Behavior and examples.

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

Request template (uses configured service base URL):

curl --fail-with-body "$SERVICE_URL/api/audio/routing/container-check"

GET /api/usb/tree

Handler: usb_tree. Source: hr_system_console/api/system_console/main.py:851. Behavior and examples.

No explicit handler arguments beyond framework state.

Request template (uses configured service base URL):

curl --fail-with-body "$SERVICE_URL/api/usb/tree"

GET /api/jetson/status

Handler: jetson_status. Source: hr_system_console/api/system_console/main.py:855. Behavior and examples.

No explicit handler arguments beyond framework state.

Request template (uses configured service base URL):

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

POST /api/jetson/perception/restart

Handler: jetson_perception_restart. Source: hr_system_console/api/system_console/main.py:859. Behavior and examples.

No explicit handler arguments beyond framework state.

Background task labels: 'Restart Jetson perception'. Follow task completion; the initial response is not completion.

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/jetson/provision

Handler: jetson_provision. Source: hr_system_console/api/system_console/main.py:867. Behavior and examples.

Argument	Location	Type	Default
payload	JSON body/model	SetupPayload	required

Observed dictionary fields (including directly traced delegate methods):

Object	Field	Lookup default
values	stackVersion	None

Background task labels: 'Provision Jetson perception'. Follow task completion; the initial response is not completion.

Direct source delegates (static trace):

• provision_jetson in hr_system_console/api/system_console/setup.py:1257

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/jetson/update

Handler: jetson_update. Source: hr_system_console/api/system_console/main.py:871. Behavior and examples.

No explicit handler arguments beyond framework state.

Background task labels: 'Update Jetson SDK containers'. Follow task completion; the initial response is not completion.

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/tasks/{task_id}

Handler: task. Source: hr_system_console/api/system_console/main.py:875. Behavior and examples.

Argument	Location	Type	Default
task_id	path	str	required

Explicit handler errors:

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

WEBSOCKET /ws

Handler: websocket_endpoint. Source: hr_system_console/api/system_console/main.py:882. Behavior and examples.

No explicit handler arguments beyond framework state.

Observed dictionary fields (including directly traced delegate methods):

Object	Field	Lookup default
message	requestId	None
message	type	None

GET /

Handler: index. Source: hr_system_console/api/system_console/main.py:902. Behavior and examples.

No explicit handler arguments beyond framework state.

Explicit handler errors:

HTTPException(status_code=404, detail='Frontend has not been built')

GET /{path:path}

Handler: spa. Source: hr_system_console/api/system_console/main.py:909. Behavior and examples.

Argument	Location	Type	Default
path	path	str	required

Explicit handler errors:

HTTPException(status_code=404, detail='Frontend has not been built')