Holds down a keyboard key without releasing it.

Hold Key

Location

Message

Error Type

ValidationError

KeyPressRequest

HTTPValidationError

cuse

cuse is an open-source framework for building AI agents that can interact with computers.

Introduction

Quickstart

Core interface for interacting with virtual computers

Computer

Create custom applications for your virtual computer

init

start

stop

status

list

destroy

Moves the mouse cursor to the specified X and Y coordinates on the screen.

Move Mouse Cursor

Performs a left mouse button click at the current cursor position.

Perform Left Click

Performs a right mouse button click at the current cursor position.

Perform Right Click

Performs a middle mouse button (scroll wheel) click at the current cursor position.

Perform Middle Click

Performs a double left click at the current cursor position.

Perform Double Click

Performs a drag operation from the current cursor position to the specified coordinates.

Drag Mouse

Gets the current position of the mouse cursor on the screen.

Get Cursor Position

Scrolls the mouse wheel by the specified number of clicks.

Scroll Mouse Wheel

Press Key

Types a sequence of text with configurable speed and grouping.

Type Text

Presses multiple keys simultaneously to perform a hotkey combination.

Press Hotkey Combination

Release Key

Captures a screenshot of the specified display.

Take Screenshot

Retrieves the dimensions of the specified display.

Get Screen Size

Searches for a specified image on the screen and returns its location if found.

Locate Image on Screen

Retrieves the RGB color values of a pixel at the specified coordinates.

Get Pixel Color

Executes a shell command and returns its output or background process information.

Execute Shell Command

Retrieves the output of a background process by its ID.

Get Process Output

Terminates a background process by its ID.

Terminate Process

Restart System

Lists all background processes managed by the system.

List Managed Processes

Retrieves the contents of a file, optionally within a specified line range.

View File Contents

Creates a new file with optional initial content.

Create New File

Replaces all occurrences of a string in a file with a new string.

Replace String

Inserts text at a specified line number in a file.

Insert Text

Undo Last Edit

Stores a new keychain item for a service.

Store Keychain Item

Delete Keychain Item

Lists all services with stored keychain items.

List Services

Verifies authentication elements against stored keychain item.

Authenticate Service

Lists the contents of a directory with optional filtering.

List Directory Contents

Generates a tree representation of a directory structure.

Get Directory Tree

Searches for files matching a pattern in a directory tree.

Search Files

Gets detailed information about a file or directory.

mouse

keyboard

display

bash

editor

keychain

filesystem

API Reference

Hold Key

Body

Response