{"title":"Computer Control API","slug":"computers","category":"api","summary":"Remote control of registered computers — queue commands, take screenshots, run scripts on remote machines.","audience":["human","llm"],"tags":["api","computers","remote-control","automation"],"difficulty":"advanced","updated":"2026-06-27","word_count":346,"read_minutes":2,"llm_context":"Two sides: user-facing (Mind Key/JWT) and agent-facing (Computer Token)\nRegister agent: POST /computers/register { install_code } → returns computer_token\nList: GET /computers/list (Mind Key or JWT)\nQueue command: POST /computers/:id/commands { type, payload }\nCommand types: screenshot, click, move, type, key, scroll, drag\nAgent poll: GET /computers/me/poll?wait=5 (Computer Token)\nAgent result: POST /computers/me/commands/:cid/result (Computer Token)\nOne-shot screenshot: GET /computers/:id/screenshot (waits 30s for result)\nPattern: register agent on remote machine → user queues commands → agent polls and executes\n","lang":"en","translated":true,"requested_lang":"en","content_markdown":"\n# Computer Control API\n\nThe Computer Control API lets you remote-control registered computers. A small\nagent (`screen-remote-agent`) runs on the target machine, polls for commands,\nexecutes them, and posts results back. This enables LLM-driven GUI automation.\n\n## Architecture\n\n```\n┌─────────────┐ queue cmd ┌──────────┐ poll ┌─────────────────┐\n│ LLM Agent │ ───────────▶ │ Synapse │ ◀───── │ screen-remote │\n│ (user-side) │ │ Server │ ──────▶│ (on target PC) │\n└─────────────┘ └──────────┘ result └─────────────────┘\n ▲\n │\n ┌─────────────┐\n │ Human UI │\n │ (browser) │\n └─────────────┘\n```\n\n## User-Facing Endpoints (Mind Key or JWT)\n\n### GET /computers/list\n\nList all registered computers.\n\n```bash\ncurl -H \"Authorization: Bearer YOUR_MIND_KEY\" \\\n https://synapse.schaefer.zone/computers/list\n```\n\n### GET /computers/:id\n\nGet details of a single computer.\n\n```bash\ncurl -H \"Authorization: Bearer YOUR_MIND_KEY\" \\\n https://synapse.schaefer.zone/computers/comp_001\n```\n\n### POST /computers/install-code\n\nGenerate an install code for registering a new computer.\n\n```bash\ncurl -X POST https://synapse.schaefer.zone/computers/install-code \\\n -H \"Authorization: Bearer YOUR_MIND_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"computer_name\": \"office-mac\"}'\n```\n\nResponse: `{ \"install_code\": \"ic_xyz789\", \"expires_at\": \"...\" }`\n\n### POST /computers/:id/commands\n\nQueue a command for the remote agent to execute.\n\n```bash\ncurl -X POST https://synapse.schaefer.zone/computers/comp_001/commands \\\n -H \"Authorization: Bearer YOUR_MIND_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"type\": \"screenshot\",\n \"payload\": {}\n }'\n```\n\nResponse: `{ \"command_id\": \"cmd_001\", \"status\": \"queued\" }`\n\n### GET /computers/:id/command (via query)\n\nQueue a command via GET (for simple cases).\n\n```bash\ncurl -H \"Authorization: Bearer YOUR_MIND_KEY\" \\\n \"https://synapse.schaefer.zone/computers/comp_001/command?type=screenshot\"\n```\n\n### GET /computers/:id/commands\n\nList recent commands for a computer.\n\n```bash\ncurl -H \"Authorization: Bearer YOUR_MIND_KEY\" \\\n \"https://synapse.schaefer.zone/computers/comp_001/commands?limit=50\"\n```\n\n### GET /computers/:id/commands/:cid\n\nGet status + result of a specific command.\n\n```bash\ncurl -H \"Authorization: Bearer YOUR_MIND_KEY\" \\\n https://synapse.schaefer.zone/computers/comp_001/commands/cmd_001\n```\n\n### GET /computers/:id/screenshot\n\nOne-shot: queue a screenshot command and wait up to 30s for the result.\n\n```bash\ncurl -H \"Authorization: Bearer YOUR_MIND_KEY\" \\\n https://synapse.schaefer.zone/computers/comp_001/screenshot > screenshot.png\n```\n\n### POST /computers/:id/disable\n\nDisable a computer (revokes its token, keeps the record for audit).\n\n```bash\ncurl -X POST -H \"Authorization: Bearer YOUR_MIND_KEY\" \\\n https://synapse.schaefer.zone/computers/comp_001/disable\n```\n\n### DELETE /computers/:id\n\nDelete a computer permanently.\n\n```bash\ncurl -X DELETE -H \"Authorization: Bearer YOUR_MIND_KEY\" \\\n https://synapse.schaefer.zone/computers/comp_001\n```\n\n## Agent-Facing Endpoints (Computer Token)\n\nThese endpoints are used by the `screen-remote-agent` running on the target\nmachine. They use a Computer Token (returned by `/computers/register`), not a\nMind Key.\n\n### POST /computers/register\n\nRedeem an install code and get a Computer Token.\n\n```bash\ncurl -X POST https://synapse.schaefer.zone/computers/register \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"code\": \"ic_xyz789\",\n \"computer_name\": \"office-mac\",\n \"platform\": \"darwin\",\n \"platform_release\": \"14.5.0\",\n \"python\": \"3.12.4\"\n }'\n```\n\nResponse: `{ \"computer_id\": \"comp_001\", \"computer_token\": \"ct_...\" }`\n\n> [!CRITICAL]\n> Save the `computer_token` — it's shown only once and is required for all\n> agent-side endpoints.\n\n### GET /computers/me/poll\n\nLong-poll for new commands. The agent calls this in a loop.\n\n```bash\ncurl -H \"Authorization: Bearer ct_YOUR_COMPUTER_TOKEN\" \\\n \"https://synapse.schaefer.zone/computers/me/poll?wait=30\"\n```\n\nReturns immediately if commands are pending, or after `wait` seconds if not.\n\n### POST /computers/me/commands/:cid/result\n\nPost the result of executing a command.\n\n```bash\ncurl -X POST https://synapse.schaefer.zone/computers/me/commands/cmd_001/result \\\n -H \"Authorization: Bearer ct_YOUR_COMPUTER_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"status\": \"done\",\n \"result\": { \"screenshot_b64\": \"iVBORw0KG...\" }\n }'\n```\n\n## Command Types\n\n| Type | Payload | Description |\n|------|---------|-------------|\n| `screenshot` | `{}` | Capture screen as PNG (base64) |\n| `click` | `{x, y}` | Click at coordinates |\n| `move` | `{x, y}` | Move mouse to coordinates |\n| `type` | `{text}` | Type text at cursor |\n| `key` | `{keys: [\"Ctrl\",\"c\"]}` | Press key combo |\n| `scroll` | `{deltaX, deltaY}` | Scroll wheel |\n| `drag` | `{fromX, fromY, toX, toY}` | Drag and drop |\n\n## Common Pattern: LLM-Driven GUI Automation\n\n```python\n# LLM agent workflow\n1. List computers: GET /computers/list\n2. Take screenshot: GET /computers/:id/screenshot\n3. Analyze screenshot (vision model)\n4. Queue click: POST /computers/:id/commands {type:\"click\", payload:{x,y}}\n5. Wait for result: GET /computers/:id/commands/:cid\n6. Take new screenshot to verify\n7. Repeat until task done\n```\n\n## Next Steps\n\n- [Browser Proxy](/docs/api/browser) — separate service for browser automation\n- [Self-Hosted Agents Guide](/docs/guides/self-hosted-agents)\n","content_html":"

Computer Control API

\n

The Computer Control API lets you remote-control registered computers. A small\nagent (screen-remote-agent) runs on the target machine, polls for commands,\nexecutes them, and posts results back. This enables LLM-driven GUI automation.

\n

Architecture

\n
┌─────────────┐  queue cmd   ┌──────────┐  poll   ┌─────────────────┐\n│ LLM Agent   │ ───────────▶ │ Synapse  │ ◀───── │ screen-remote   │\n│ (user-side) │              │  Server  │ ──────▶│ (on target PC)  │\n└─────────────┘              └──────────┘ result  └─────────────────┘\n                                     ▲\n                                     │\n                              ┌─────────────┐\n                              │  Human UI   │\n                              │ (browser)   │\n                              └─────────────┘

User-Facing Endpoints (Mind Key or JWT)

\n

GET /computers/list

\n

List all registered computers.

\n
curl -H "Authorization: Bearer YOUR_MIND_KEY" \\\n     https://synapse.schaefer.zone/computers/list

GET /computers/:id

\n

Get details of a single computer.

\n
curl -H "Authorization: Bearer YOUR_MIND_KEY" \\\n     https://synapse.schaefer.zone/computers/comp_001

POST /computers/install-code

\n

Generate an install code for registering a new computer.

\n
curl -X POST https://synapse.schaefer.zone/computers/install-code \\\n  -H "Authorization: Bearer YOUR_MIND_KEY" \\\n  -H "Content-Type: application/json" \\\n  -d '{"computer_name": "office-mac"}'

Response: { "install_code": "ic_xyz789", "expires_at": "..." }

\n

POST /computers/:id/commands

\n

Queue a command for the remote agent to execute.

\n
curl -X POST https://synapse.schaefer.zone/computers/comp_001/commands \\\n  -H "Authorization: Bearer YOUR_MIND_KEY" \\\n  -H "Content-Type: application/json" \\\n  -d '{\n    "type": "screenshot",\n    "payload": {}\n  }'

Response: { "command_id": "cmd_001", "status": "queued" }

\n

GET /computers/:id/command (via query)

\n

Queue a command via GET (for simple cases).

\n
curl -H "Authorization: Bearer YOUR_MIND_KEY" \\\n     "https://synapse.schaefer.zone/computers/comp_001/command?type=screenshot"

GET /computers/:id/commands

\n

List recent commands for a computer.

\n
curl -H "Authorization: Bearer YOUR_MIND_KEY" \\\n     "https://synapse.schaefer.zone/computers/comp_001/commands?limit=50"

GET /computers/:id/commands/:cid

\n

Get status + result of a specific command.

\n
curl -H "Authorization: Bearer YOUR_MIND_KEY" \\\n     https://synapse.schaefer.zone/computers/comp_001/commands/cmd_001

GET /computers/:id/screenshot

\n

One-shot: queue a screenshot command and wait up to 30s for the result.

\n
curl -H "Authorization: Bearer YOUR_MIND_KEY" \\\n     https://synapse.schaefer.zone/computers/comp_001/screenshot > screenshot.png

POST /computers/:id/disable

\n

Disable a computer (revokes its token, keeps the record for audit).

\n
curl -X POST -H "Authorization: Bearer YOUR_MIND_KEY" \\\n     https://synapse.schaefer.zone/computers/comp_001/disable

DELETE /computers/:id

\n

Delete a computer permanently.

\n
curl -X DELETE -H "Authorization: Bearer YOUR_MIND_KEY" \\\n     https://synapse.schaefer.zone/computers/comp_001

Agent-Facing Endpoints (Computer Token)

\n

These endpoints are used by the screen-remote-agent running on the target\nmachine. They use a Computer Token (returned by /computers/register), not a\nMind Key.

\n

POST /computers/register

\n

Redeem an install code and get a Computer Token.

\n
curl -X POST https://synapse.schaefer.zone/computers/register \\\n  -H "Content-Type: application/json" \\\n  -d '{\n    "code": "ic_xyz789",\n    "computer_name": "office-mac",\n    "platform": "darwin",\n    "platform_release": "14.5.0",\n    "python": "3.12.4"\n  }'

Response: { "computer_id": "comp_001", "computer_token": "ct_..." }

\n
Save the `computer_token` — it's shown only once and is required for all\nagent-side endpoints.

GET /computers/me/poll

\n

Long-poll for new commands. The agent calls this in a loop.

\n
curl -H "Authorization: Bearer ct_YOUR_COMPUTER_TOKEN" \\\n     "https://synapse.schaefer.zone/computers/me/poll?wait=30"

Returns immediately if commands are pending, or after wait seconds if not.

\n

POST /computers/me/commands/:cid/result

\n

Post the result of executing a command.

\n
curl -X POST https://synapse.schaefer.zone/computers/me/commands/cmd_001/result \\\n  -H "Authorization: Bearer ct_YOUR_COMPUTER_TOKEN" \\\n  -H "Content-Type: application/json" \\\n  -d '{\n    "status": "done",\n    "result": { "screenshot_b64": "iVBORw0KG..." }\n  }'

Command Types

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
TypePayloadDescription
screenshot{}Capture screen as PNG (base64)
click{x, y}Click at coordinates
move{x, y}Move mouse to coordinates
type{text}Type text at cursor
key{keys: ["Ctrl","c"]}Press key combo
scroll{deltaX, deltaY}Scroll wheel
drag{fromX, fromY, toX, toY}Drag and drop
\n

Common Pattern: LLM-Driven GUI Automation

\n
# LLM agent workflow\n1. List computers: GET /computers/list\n2. Take screenshot: GET /computers/:id/screenshot\n3. Analyze screenshot (vision model)\n4. Queue click: POST /computers/:id/commands {type:"click", payload:{x,y}}\n5. Wait for result: GET /computers/:id/commands/:cid\n6. Take new screenshot to verify\n7. Repeat until task done

Next Steps

\n\n","urls":{"html":"/docs/api/computers","text":"/docs/api/computers?format=text","json":"/docs/api/computers?format=json","llm":"/docs/api/computers?format=llm"},"translations_available":["en","zh","hi","es","fr","ar","pt","ru","ja","de","it","ko","nl","pl","tr","sv","vi","th","id","uk"]}