Computer Use

Find accessibility nodes

POST/computeruse/a11y/find

Search the AT-SPI tree for nodes matching a role/name/state filter and return a flat list.

Request Body

application/json

Find request

TypeScript Definitions

Use the request body type in TypeScript.

limit?integer

name?string

nameMatch?string

"exact" | "substring" | "regex"

pid?integer

role?string

scope?string

states?array<string>

Response Body

`application/json`

curl -X POST "https://example.com/computeruse/a11y/find" \  -H "Content-Type: application/json" \  -d '{}'

{  "matches": [    {      "actions": [        "string"      ],      "bounds": {        "height": 0,        "width": 0,        "x": 0,        "y": 0      },      "children": [        {}      ],      "description": "string",      "id": "string",      "name": "string",      "role": "string",      "states": [        "string"      ]    }  ],  "truncated": true}

Focus an accessibility node

POST/computeruse/a11y/node/focus

Move keyboard focus to the AT-SPI node identified by id (bus-name:object-path).

Request Body

application/json

Node focus request

TypeScript Definitions

Use the request body type in TypeScript.

id*string

Response Body

`application/json`

curl -X POST "https://example.com/computeruse/a11y/node/focus" \  -H "Content-Type: application/json" \  -d '{    "id": "string"  }'

{}

Invoke an action on an accessibility node

POST/computeruse/a11y/node/invoke

Call an AT-SPI Action on the node. Leave action empty to invoke the node's primary (first) action.

Request Body

application/json

Invoke request

TypeScript Definitions

Use the request body type in TypeScript.

action?string

id*string

Response Body

`application/json`

curl -X POST "https://example.com/computeruse/a11y/node/invoke" \  -H "Content-Type: application/json" \  -d '{    "id": "string"  }'

{}

Set the value of an accessibility node

POST/computeruse/a11y/node/value

Write the given value to the node via EditableText.SetTextContents or, for numeric controls, Value.CurrentValue.

Request Body

application/json

Set value request

TypeScript Definitions

Use the request body type in TypeScript.

id*string

value?string

Response Body

`application/json`

curl -X POST "https://example.com/computeruse/a11y/node/value" \  -H "Content-Type: application/json" \  -d '{    "id": "string"  }'

{}

Get accessibility tree

GET/computeruse/a11y/tree

Fetch the AT-SPI accessibility tree for the focused application, a specific PID, or all registered applications.

Query Parameters

scope?string

Scope: focused | pid | all (default: focused)

pid?integer

Process ID when scope=pid

maxDepth?integer

Max tree depth (-1 unbounded, 0 root only; default -1)

Response Body

`application/json`

curl -X GET "https://example.com/computeruse/a11y/tree"

{  "root": {    "actions": [      "string"    ],    "bounds": {      "height": 0,      "width": 0,      "x": 0,      "y": 0    },    "children": [      {}    ],    "description": "string",    "id": "string",    "name": "string",    "role": "string",    "states": [      "string"    ]  },  "truncated": true}

Get display information

GET/computeruse/display/info

Get information about all available displays

Response Body

`application/json`

curl -X GET "https://example.com/computeruse/display/info"

{  "displays": [    {      "height": 0,      "id": 0,      "isActive": true,      "width": 0,      "x": 0,      "y": 0    }  ]}

Get windows information

GET/computeruse/display/windows

Get information about all open windows

Response Body

`application/json`

curl -X GET "https://example.com/computeruse/display/windows"

{  "windows": [    {      "height": 0,      "id": 0,      "isActive": true,      "title": "string",      "width": 0,      "x": 0,      "y": 0    }  ]}

Press hotkey

POST/computeruse/keyboard/hotkey

Press a hotkey combination (e.g., ctrl+c, cmd+v)

Request Body

application/json

Hotkey press request

TypeScript Definitions

Use the request body type in TypeScript.

keys?string

e.g., "ctrl+c", "cmd+v"

Response Body

`application/json`

curl -X POST "https://example.com/computeruse/keyboard/hotkey" \  -H "Content-Type: application/json" \  -d '{}'

{}

Press key

POST/computeruse/keyboard/key

Press a key with optional modifiers

Request Body

application/json

Key press request

TypeScript Definitions

Use the request body type in TypeScript.

key?string

modifiers?array<string>

ctrl, alt, shift, cmd

Response Body

`application/json`

curl -X POST "https://example.com/computeruse/keyboard/key" \  -H "Content-Type: application/json" \  -d '{}'

{}

Type text

POST/computeruse/keyboard/type

Type text with optional delay between keystrokes

Request Body

application/json

Text typing request

TypeScript Definitions

Use the request body type in TypeScript.

delay?integer

milliseconds between keystrokes

text?string

Response Body

`application/json`

curl -X POST "https://example.com/computeruse/keyboard/type" \  -H "Content-Type: application/json" \  -d '{}'

{}

Click mouse button

POST/computeruse/mouse/click

Click the mouse button at the specified coordinates

Request Body

application/json

Mouse click request

TypeScript Definitions

Use the request body type in TypeScript.

button?string

left, right, middle

double?boolean

x?integer

y?integer

Response Body

`application/json`

curl -X POST "https://example.com/computeruse/mouse/click" \  -H "Content-Type: application/json" \  -d '{}'

{  "x": 0,  "y": 0}

Drag mouse

POST/computeruse/mouse/drag

Drag the mouse from start to end coordinates

Request Body

application/json

Mouse drag request

TypeScript Definitions

Use the request body type in TypeScript.

button?string

endX?integer

endY?integer

startX?integer

startY?integer

Response Body

`application/json`

curl -X POST "https://example.com/computeruse/mouse/drag" \  -H "Content-Type: application/json" \  -d '{}'

{  "x": 0,  "y": 0}

Move mouse cursor

POST/computeruse/mouse/move

Move the mouse cursor to the specified coordinates

Request Body

application/json

Mouse move request

TypeScript Definitions

Use the request body type in TypeScript.

x?integer

y?integer

Response Body

`application/json`

curl -X POST "https://example.com/computeruse/mouse/move" \  -H "Content-Type: application/json" \  -d '{}'

{  "x": 0,  "y": 0}

Get mouse position

GET/computeruse/mouse/position

Get the current mouse cursor position

Response Body

`application/json`

curl -X GET "https://example.com/computeruse/mouse/position"

{  "x": 0,  "y": 0}

Scroll mouse wheel

POST/computeruse/mouse/scroll

Scroll the mouse wheel at the specified coordinates

Request Body

application/json

Mouse scroll request

TypeScript Definitions

Use the request body type in TypeScript.

amount?integer

Range0 <= value

Default1

direction?string

up, down

x?integer

y?integer

Response Body

`application/json`

curl -X POST "https://example.com/computeruse/mouse/scroll" \  -H "Content-Type: application/json" \  -d '{}'

{  "success": true}

Get computer use process status

GET/computeruse/process-status

Get the status of all computer use processes

Response Body

`application/json`

curl -X GET "https://example.com/computeruse/process-status"

{  "status": "string"}

Get process errors

GET/computeruse/process/{processName}/errors

Get errors for a specific computer use process

Path Parameters

processName*string

Process name to get errors for

Response Body

`application/json`

curl -X GET "https://example.com/computeruse/process/string/errors"

{  "errors": "string",  "processName": "string"}

Get process logs

GET/computeruse/process/{processName}/logs

Get logs for a specific computer use process

Path Parameters

processName*string

Process name to get logs for

Response Body

`application/json`

curl -X GET "https://example.com/computeruse/process/string/logs"

{  "logs": "string",  "processName": "string"}

Restart specific process

POST/computeruse/process/{processName}/restart

Restart a specific computer use process

Path Parameters

processName*string

Process name to restart

Response Body

`application/json`

curl -X POST "https://example.com/computeruse/process/string/restart"

{  "message": "string",  "processName": "string"}

Get specific process status

GET/computeruse/process/{processName}/status

Check if a specific computer use process is running

Path Parameters

processName*string

Process name to check

Response Body

`application/json`

curl -X GET "https://example.com/computeruse/process/string/status"

{  "processName": "string",  "running": true}

List all recordings

GET/computeruse/recordings

Get a list of all recordings (active and completed)

Response Body

`application/json`

curl -X GET "https://example.com/computeruse/recordings"

{  "recordings": [    {      "durationSeconds": 0,      "endTime": "string",      "fileName": "string",      "filePath": "string",      "id": "string",      "sizeBytes": 0,      "startTime": "string",      "status": "string"    }  ]}

Start a new recording

POST/computeruse/recordings/start

Start a new screen recording session

Request Body

application/json

Recording options

TypeScript Definitions

Use the request body type in TypeScript.

label?string

Response Body

`application/json`

curl -X POST "https://example.com/computeruse/recordings/start" \  -H "Content-Type: application/json" \  -d '{}'

{  "durationSeconds": 0,  "endTime": "string",  "fileName": "string",  "filePath": "string",  "id": "string",  "sizeBytes": 0,  "startTime": "string",  "status": "string"}

Stop a recording

POST/computeruse/recordings/stop

Stop an active screen recording session

Request Body

application/json

Recording ID to stop

TypeScript Definitions

Use the request body type in TypeScript.

id*string

Response Body

`application/json`

curl -X POST "https://example.com/computeruse/recordings/stop" \  -H "Content-Type: application/json" \  -d '{    "id": "string"  }'

{  "durationSeconds": 0,  "endTime": "string",  "fileName": "string",  "filePath": "string",  "id": "string",  "sizeBytes": 0,  "startTime": "string",  "status": "string"}

Get recording details

GET/computeruse/recordings/{id}

Get details of a specific recording by ID

Path Parameters

id*string

Recording ID

Response Body

`application/json`

curl -X GET "https://example.com/computeruse/recordings/string"

{  "durationSeconds": 0,  "endTime": "string",  "fileName": "string",  "filePath": "string",  "id": "string",  "sizeBytes": 0,  "startTime": "string",  "status": "string"}

Delete a recording

DELETE/computeruse/recordings/{id}

Delete a recording file by ID

Path Parameters

id*string

Recording ID

Response Body

`/`

curl -X DELETE "https://example.com/computeruse/recordings/string"

Empty

Download a recording

GET/computeruse/recordings/{id}/download

Download a recording by providing its ID

Path Parameters

id*string

Recording ID

Response Body

`application/octet-stream`

curl -X GET "https://example.com/computeruse/recordings/string/download"

Empty

Take a screenshot

GET/computeruse/screenshot

Take a screenshot of the entire screen

Query Parameters

showCursor?boolean

Whether to show cursor in screenshot

Response Body

`application/json`

curl -X GET "https://example.com/computeruse/screenshot"

{  "cursorPosition": {    "x": 0,    "y": 0  },  "screenshot": "string",  "sizeBytes": 0}

Take a compressed screenshot

GET/computeruse/screenshot/compressed

Take a compressed screenshot of the entire screen

Query Parameters

showCursor?boolean

Whether to show cursor in screenshot

format?string

Image format (png or jpeg)

quality?integer

JPEG quality (1-100)

scale?number

Scale factor (0.1-1.0)

Response Body

`application/json`

curl -X GET "https://example.com/computeruse/screenshot/compressed"

{  "cursorPosition": {    "x": 0,    "y": 0  },  "screenshot": "string",  "sizeBytes": 0}

Take a region screenshot

GET/computeruse/screenshot/region

Take a screenshot of a specific region of the screen

Query Parameters

x*integer

X coordinate of the region

y*integer

Y coordinate of the region

width*integer

Width of the region

height*integer

Height of the region

showCursor?boolean

Whether to show cursor in screenshot

Response Body

`application/json`

curl -X GET "https://example.com/computeruse/screenshot/region?x=0&y=0&width=0&height=0"

{  "cursorPosition": {    "x": 0,    "y": 0  },  "screenshot": "string",  "sizeBytes": 0}

Take a compressed region screenshot

GET/computeruse/screenshot/region/compressed

Take a compressed screenshot of a specific region of the screen

Query Parameters

x*integer

X coordinate of the region

y*integer

Y coordinate of the region

width*integer

Width of the region

height*integer

Height of the region

showCursor?boolean

Whether to show cursor in screenshot

format?string

Image format (png or jpeg)

quality?integer

JPEG quality (1-100)

scale?number

Scale factor (0.1-1.0)

Response Body

`application/json`

curl -X GET "https://example.com/computeruse/screenshot/region/compressed?x=0&y=0&width=0&height=0"

{  "cursorPosition": {    "x": 0,    "y": 0  },  "screenshot": "string",  "sizeBytes": 0}

Start computer use processes

POST/computeruse/start

Start all computer use processes and return their status

Response Body

`application/json`

curl -X POST "https://example.com/computeruse/start"

{  "message": "string",  "status": {    "property1": {      "autoRestart": true,      "pid": 0,      "priority": 0,      "running": true    },    "property2": {      "autoRestart": true,      "pid": 0,      "priority": 0,      "running": true    }  }}

Get computer use status

GET/computeruse/status

Get the current status of the computer use system

Response Body

`application/json`

curl -X GET "https://example.com/computeruse/status"

{  "status": "string"}

Stop computer use processes

POST/computeruse/stop

Stop all computer use processes and return their status

Response Body

`application/json`

curl -X POST "https://example.com/computeruse/stop"

{  "message": "string",  "status": {    "property1": {      "autoRestart": true,      "pid": 0,      "priority": 0,      "running": true    },    "property2": {      "autoRestart": true,      "pid": 0,      "priority": 0,      "running": true    }  }}

Computer Use

200application/json

400application/json

404application/json

500application/json

503application/json

200application/json

400application/json

404application/json

500application/json

503application/json

200application/json

400application/json

404application/json

500application/json

503application/json

200application/json

400application/json

404application/json

500application/json

503application/json

200application/json

400application/json

404application/json

500application/json

503application/json

200application/json

500application/json

200application/json

500application/json

200application/json

400application/json

500application/json

200application/json

400application/json

500application/json

200application/json

400application/json

500application/json

200application/json

400application/json

500application/json

200application/json

400application/json

500application/json

200application/json

400application/json

500application/json

200application/json

500application/json

200application/json

400application/json

500application/json

200application/json

200application/json

200application/json

200application/json

200application/json

200application/json

500application/json

201application/json

400application/json

500application/json

503application/json

200application/json

400application/json

404application/json

500application/json

200application/json

400application/json

404application/json

500application/json

204

400*/*

404*/*

409*/*

500*/*

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`/`

`/`

`/`

`/`