HTTP API reference

One route for every tool.

Health is for readiness, MCP is for protocol clients, and JSON execution is for the manual GUI or another agreed computer.

Health

GET /health

Returns ok, transport, and headless_preferred. The default port is 8765.

POST /api/execute
Content-Type: application/json

{"tool":"list_headless_desktops","arguments":{}}

Every tool name available to MCP can be dispatched. Results retain factual error details.

upload_file accepts a destination and bounded base64 payload; download_file returns bounded base64. Keep the API on a trusted private network.