System & Control APIs

Endpoints for metrics, screen vision, computer control, LLM access, settings, and telemetry.

Beyond chat and widgets, the agent exposes endpoints for system metrics, screen analysis, agentic computer control, direct LLM access, and configuration.

System metrics

GET /api/system/metricsendpoint

Live CPU, RAM, and disk metrics. Backs the system dashboard and the df / free fast-path commands.

bash
curl http://127.0.0.1:8000/api/system/metrics

Screen vision

POST /api/screen/analyzeendpoint

Capture the active screen and analyze it with the vision model β€” used for "what's on my screen?" style queries and the screen-reader plugin.

POST /api/screen/insertendpoint

Insert/paste generated text into the currently focused application.

Computer control

The agentic control loop that powers Computer Control. The agent takes a screenshot, decides the next GUI action, executes it, and repeats.

POST /api/computer/executeendpoint

Start an agentic computer-control task (open apps, click, type, run terminal commands, drive an IDE).

POST /api/computer/stopendpoint

Stop the running control loop.

Warning

Computer control can click, type, and run terminal commands on your machine. Treat it like handing over the keyboard β€” review what you ask it to do.

POST /api/overlay/showendpoint

Show a transient overlay UI on the desktop.

POST /project/setupendpoint

Scaffold a new project (backed by the project_setup plugin).

Direct LLM & text tools

POST /api/llmendpoint

Make a direct LLM call through the agent's configured provider β€” handy for scripting against whatever model LLM_MODEL points at.

POST /api/assistendpoint

General text assistance (used by the writing assistant widget).

POST /api/transformendpoint

Transform selected text β€” improve, shorten, expand, fix grammar, continue.

Files & ingestion

POST /api/uploadendpoint

Upload a file to the agent.

POST /api/file-ingestendpoint

Ingest a file's contents into context (parsed via the document handlers).

Settings

GET /api/settingsendpoint

Read current settings.

POST /api/settingsendpoint

Update settings. Because LLM config values are live properties, updating provider/key/ model takes effect without restarting the agent.

bash
curl -X POST http://127.0.0.1:8000/api/settings \
 -H "Content-Type: application/json" \
 -d '{"LLM_MODEL": "anthropic/claude-sonnet-4-6"}'

Telemetry & notifications

POST /api/ui_telemetryendpoint

The shell reports render successes/failures here so bad component shapes can be found.

GET /api/ui_telemetryendpoint

Read accumulated render telemetry.

GET /api/notificationsendpoint

Notifications raised by the proactive monitor (calendar reminders, system-health alerts). See.

GET /api/dashboardendpoint

Aggregated dashboard data.

Inbound webhooks

POST /webhook/google-chatendpoint

Receive Google Chat events.

POST /webhook/teamsendpoint

Receive Microsoft Teams events.

POST /cli/dispatchendpoint

Dispatch a command from the bundled megha CLI.