Sign Up

ComputerUseService

class ComputerUseService()

ComputerUseService.__init__

def __init__(transport: AsyncTransport) -> None

ComputerUseService.status

async def status() -> ComputerUseStatusResponse

ComputerUseService.start

async def start() -> ComputerUseLifecycleResult

ComputerUseService.stop

async def stop() -> ComputerUseLifecycleResult

ComputerUseService.restart

async def restart() -> ComputerUseRestartResponse

AddonProcessesService

class AddonProcessesService()

AddonProcessesService.__init__

def __init__(transport: AsyncTransport) -> None

AddonProcessesService.status

@overload
async def status() -> dict[str, ComputerUseProcessStatus]

AddonProcessesService.status

@overload
async def status(name: str) -> ComputerUseProcessRunningStatus

AddonProcessesService.restart

async def restart(name: str) -> ComputerUseProcessRestartResult

AddonProcessesService.logs

async def logs(name: str) -> ComputerUseProcessLogs

AddonProcessesService.errors

async def errors(name: str) -> ComputerUseProcessErrors

MouseService

class MouseService()

MouseService.__init__

def __init__(transport: AsyncTransport) -> None

MouseService.position

async def position() -> ComputerUsePoint

MouseService.move

async def move(*, x: int, y: int) -> ComputerUsePoint

MouseService.click

async def click(*,
                x: int,
                y: int,
                button: ComputerUseMouseButton | None = None,
                double: bool | None = None) -> ComputerUsePoint

MouseService.drag

async def drag(*,
               start_x: int,
               start_y: int,
               end_x: int,
               end_y: int,
               button: ComputerUseMouseButton | None = None) -> ComputerUsePoint

MouseService.scroll

async def scroll(*,
                 x: int,
                 y: int,
                 direction: ComputerUseScrollDirection,
                 amount: int | None = None) -> ComputerUseScrollResult

KeyboardService

class KeyboardService()

KeyboardService.__init__

def __init__(transport: AsyncTransport) -> None

KeyboardService.type

async def type(*, text: str, delay: int | None = None) -> None

KeyboardService.key

async def key(*,
              key: str,
              modifiers: Sequence[ComputerUseKeyboardModifier] | None = None) -> None

KeyboardService.hotkey

async def hotkey(*, keys: str) -> None

ScreenService

class ScreenService()

ScreenService.__init__

def __init__(transport: AsyncTransport) -> None

ScreenService.capture

async def capture(*, show_cursor: bool | None = None) -> ComputerUseScreenshot

ScreenService.region

async def region(*,
                 x: int,
                 y: int,
                 width: int,
                 height: int,
                 show_cursor: bool | None = None) -> ComputerUseScreenshot

ScreenService.capture_compressed

async def capture_compressed(*,
                             format: ComputerUseScreenshotFormat | None = None,
                             quality: int | None = None,
                             scale: float | None = None,
                             show_cursor: bool | None = None) -> ComputerUseScreenshot

ScreenService.region_compressed

async def region_compressed(*,
                            x: int,
                            y: int,
                            width: int,
                            height: int,
                            format: ComputerUseScreenshotFormat | None = None,
                            quality: int | None = None,
                            scale: float | None = None,
                            show_cursor: bool | None = None) -> ComputerUseScreenshot

DisplayService

class DisplayService()

DisplayService.__init__

def __init__(transport: AsyncTransport) -> None

DisplayService.info

async def info() -> ComputerUseDisplayInfo

DisplayService.windows

async def windows() -> ComputerUseDisplayWindows

A11yService

class A11yService()

A11yService.__init__

def __init__(transport: AsyncTransport) -> None

A11yService.tree

async def tree(*,
               scope: ComputerUseA11yScope,
               pid: int | None = None,
               max_depth: int | None = None) -> ComputerUseA11yTree

A11yService.find

async def find(*,
               scope: ComputerUseA11yScope,
               pid: int | None = None,
               role: str | None = None,
               name: str | None = None,
               name_match: ComputerUseA11yNameMatch | None = None,
               states: Sequence[str] | None = None,
               limit: int | None = None) -> ComputerUseA11yFindResult

A11yService.focus

async def focus(*, id: str) -> None

A11yService.invoke

async def invoke(*, id: str, action: str | None = None) -> None

A11yService.set_value

async def set_value(*, id: str, value: str) -> None

RecordingService

class RecordingService()

RecordingService.__init__

def __init__(transport: AsyncTransport) -> None

RecordingService.start

async def start(*, label: str | None = None) -> ComputerUseRecording

RecordingService.stop

async def stop(*, id: str) -> ComputerUseRecording

RecordingService.list

async def list() -> ComputerUseRecordingList

RecordingService.get

async def get(id: str) -> ComputerUseRecording

RecordingService.download

async def download(id: str) -> bytes

RecordingService.delete

async def delete(id: str) -> None

ComputerUseDesktopFailure

@dataclass(frozen=True, slots=True)
class ComputerUseDesktopFailure()

Attributes:

  • code ComputerUseDesktopFailureCode
  • message str
  • extra_fields Optional[Dict[str, JsonValue]] = None
  • raw_code Optional[str] = None

ComputerUseNotStartedStatus

@dataclass(frozen=True, slots=True)
class ComputerUseNotStartedStatus()

Attributes:

  • status Literal['inactive'] = 'inactive'
  • desktop Literal['not_started'] = 'not_started'
  • cause None = None
  • extra_fields Optional[Dict[str, JsonValue]] = None

ComputerUseStartingStatus

@dataclass(frozen=True, slots=True)
class ComputerUseStartingStatus()

Attributes:

  • status Literal['inactive'] = 'inactive'
  • desktop Literal['starting'] = 'starting'
  • cause None = None
  • extra_fields Optional[Dict[str, JsonValue]] = None

ComputerUseReadyStatus

@dataclass(frozen=True, slots=True)
class ComputerUseReadyStatus()

Attributes:

  • status Literal['active'] = 'active'
  • desktop Literal['ready'] = 'ready'
  • cause None = None
  • extra_fields Optional[Dict[str, JsonValue]] = None

ComputerUseFailedStatus

@dataclass(frozen=True, slots=True)
class ComputerUseFailedStatus()

Attributes:

  • cause ComputerUseDesktopFailure
  • status Literal['inactive'] = 'inactive'
  • desktop Literal['failed'] = 'failed'
  • extra_fields Optional[Dict[str, JsonValue]] = None

ComputerUseRestartResponse

@dataclass(frozen=True, slots=True)
class ComputerUseRestartResponse()

Attributes:

  • message str
  • status Literal['active'] = 'active'
  • desktop Literal['ready'] = 'ready'
  • extra_fields Optional[Dict[str, JsonValue]] = None

ComputerUseProcessStatus

@dataclass(frozen=True, slots=True)
class ComputerUseProcessStatus()

Attributes:

  • running Optional[bool] = None
  • priority Optional[int] = None
  • auto_restart Optional[bool] = None
  • pid Optional[int] = None
  • failed Optional[bool] = None
  • restart_attempts Optional[int] = None
  • restart_backoff_ms Optional[int] = None
  • status Optional[str] = None
  • extra_fields Optional[Dict[str, JsonValue]] = None

ComputerUseProcessRunningStatus

@dataclass(frozen=True, slots=True)
class ComputerUseProcessRunningStatus()

Attributes:

  • process_name str
  • running bool

ComputerUsePoint

@dataclass(frozen=True, slots=True)
class ComputerUsePoint()

Attributes:

  • x int
  • y int

ComputerUseDisplay

@dataclass(frozen=True, slots=True)
class ComputerUseDisplay()

Attributes:

  • id int
  • x int
  • y int
  • width int
  • height int
  • is_active bool

ComputerUseWindow

@dataclass(frozen=True, slots=True)
class ComputerUseWindow()

Attributes:

  • id int
  • title str
  • x int
  • y int
  • width int
  • height int
  • is_active bool

ComputerUseAccessibilityBounds

@dataclass(frozen=True, slots=True)
class ComputerUseAccessibilityBounds()

Attributes:

  • x int
  • y int
  • width int
  • height int

ComputerUseAccessibilityNode

@dataclass(frozen=True, slots=True)
class ComputerUseAccessibilityNode()

Attributes:

  • id str
  • role str
  • name str
  • bounds ComputerUseAccessibilityBounds
  • states List[str]
  • description Optional[str] = None
  • actions Optional[List[str]] = None
  • children Optional[List[ComputerUseAccessibilityNode]] = None
  • value Optional[str] = None
  • value_truncated bool = False

ComputerUseRecording

@dataclass(frozen=True, slots=True)
class ComputerUseRecording()

Attributes:

  • id str
  • file_name str
  • file_path str
  • start_time str
  • status str
  • end_time Optional[str] = None
  • duration_seconds Optional[float] = None
  • size_bytes Optional[int] = None

SyncComputerUseService

class SyncComputerUseService()

Synchronous ComputerUseService.

SyncComputerUseService.__init__

def __init__(impl: ComputerUseService, bridge: SyncBridge) -> None

SyncComputerUseService.service

@property
def service() -> SyncAddonProcessesService

SyncComputerUseService.mouse

@property
def mouse() -> SyncMouseService

SyncComputerUseService.keyboard

@property
def keyboard() -> SyncKeyboardService

SyncComputerUseService.screen

@property
def screen() -> SyncScreenService

SyncComputerUseService.display

@property
def display() -> SyncDisplayService

SyncComputerUseService.a11y

@property
def a11y() -> SyncA11yService

SyncComputerUseService.recording

@property
def recording() -> SyncRecordingService

SyncComputerUseService.restart

def restart() -> ComputerUseRestartResponse

SyncComputerUseService.start

def start() -> ComputerUseLifecycleResult

SyncComputerUseService.status

def status() -> ComputerUseStatusResponse

SyncComputerUseService.stop

def stop() -> ComputerUseLifecycleResult

SyncA11yService

class SyncA11yService()

Synchronous A11yService.

SyncA11yService.__init__

def __init__(impl: A11yService, bridge: SyncBridge) -> None

SyncA11yService.find

def find(*,
         scope: ComputerUseA11yScope,
         pid: int | None = None,
         role: str | None = None,
         name: str | None = None,
         name_match: ComputerUseA11yNameMatch | None = None,
         states: Sequence[str] | None = None,
         limit: int | None = None) -> ComputerUseA11yFindResult

SyncA11yService.focus

def focus(*, id: str) -> None

SyncA11yService.invoke

def invoke(*, id: str, action: str | None = None) -> None

SyncA11yService.set_value

def set_value(*, id: str, value: str) -> None

SyncA11yService.tree

def tree(*,
         scope: ComputerUseA11yScope,
         pid: int | None = None,
         max_depth: int | None = None) -> ComputerUseA11yTree

SyncAddonProcessesService

class SyncAddonProcessesService()

Synchronous AddonProcessesService.

SyncAddonProcessesService.__init__

def __init__(impl: AddonProcessesService, bridge: SyncBridge) -> None

SyncAddonProcessesService.errors

def errors(name: str) -> ComputerUseProcessErrors

SyncAddonProcessesService.logs

def logs(name: str) -> ComputerUseProcessLogs

SyncAddonProcessesService.restart

def restart(name: str) -> ComputerUseProcessRestartResult

SyncAddonProcessesService.status

@overload
def status() -> dict[str, ComputerUseProcessStatus]

SyncAddonProcessesService.status

@overload
def status(name: str) -> ComputerUseProcessRunningStatus

SyncDisplayService

class SyncDisplayService()

Synchronous DisplayService.

SyncDisplayService.__init__

def __init__(impl: DisplayService, bridge: SyncBridge) -> None

SyncDisplayService.info

def info() -> ComputerUseDisplayInfo

SyncDisplayService.windows

def windows() -> ComputerUseDisplayWindows

SyncKeyboardService

class SyncKeyboardService()

Synchronous KeyboardService.

SyncKeyboardService.__init__

def __init__(impl: KeyboardService, bridge: SyncBridge) -> None

SyncKeyboardService.hotkey

def hotkey(*, keys: str) -> None

SyncKeyboardService.key

def key(*,
        key: str,
        modifiers: Sequence[ComputerUseKeyboardModifier] | None = None) -> None

SyncKeyboardService.type

def type(*, text: str, delay: int | None = None) -> None

SyncMouseService

class SyncMouseService()

Synchronous MouseService.

SyncMouseService.__init__

def __init__(impl: MouseService, bridge: SyncBridge) -> None

SyncMouseService.click

def click(*,
          x: int,
          y: int,
          button: ComputerUseMouseButton | None = None,
          double: bool | None = None) -> ComputerUsePoint

SyncMouseService.drag

def drag(*,
         start_x: int,
         start_y: int,
         end_x: int,
         end_y: int,
         button: ComputerUseMouseButton | None = None) -> ComputerUsePoint

SyncMouseService.move

def move(*, x: int, y: int) -> ComputerUsePoint

SyncMouseService.position

def position() -> ComputerUsePoint

SyncMouseService.scroll

def scroll(*,
           x: int,
           y: int,
           direction: ComputerUseScrollDirection,
           amount: int | None = None) -> ComputerUseScrollResult

SyncRecordingService

class SyncRecordingService()

Synchronous RecordingService.

SyncRecordingService.__init__

def __init__(impl: RecordingService, bridge: SyncBridge) -> None

SyncRecordingService.delete

def delete(id: str) -> None

SyncRecordingService.download

def download(id: str) -> bytes

SyncRecordingService.get

def get(id: str) -> ComputerUseRecording

SyncRecordingService.list

def list() -> ComputerUseRecordingList

SyncRecordingService.start

def start(*, label: str | None = None) -> ComputerUseRecording

SyncRecordingService.stop

def stop(*, id: str) -> ComputerUseRecording

SyncScreenService

class SyncScreenService()

Synchronous ScreenService.

SyncScreenService.__init__

def __init__(impl: ScreenService, bridge: SyncBridge) -> None

SyncScreenService.capture

def capture(*, show_cursor: bool | None = None) -> ComputerUseScreenshot

SyncScreenService.capture_compressed

def capture_compressed(*,
                       format: ComputerUseScreenshotFormat | None = None,
                       quality: int | None = None,
                       scale: float | None = None,
                       show_cursor: bool | None = None) -> ComputerUseScreenshot

SyncScreenService.region

def region(*,
           x: int,
           y: int,
           width: int,
           height: int,
           show_cursor: bool | None = None) -> ComputerUseScreenshot

SyncScreenService.region_compressed

def region_compressed(*,
                      x: int,
                      y: int,
                      width: int,
                      height: int,
                      format: ComputerUseScreenshotFormat | None = None,
                      quality: int | None = None,
                      scale: float | None = None,
                      show_cursor: bool | None = None) -> ComputerUseScreenshot

ComputerUseMouseButton

ComputerUseMouseButton = Literal['left', 'right', 'middle']

ComputerUseScrollDirection

ComputerUseScrollDirection = Literal['up', 'down']

ComputerUseScreenshotFormat

ComputerUseScreenshotFormat = Literal['png', 'jpeg']

ComputerUseKeyboardModifier

ComputerUseKeyboardModifier = Literal['ctrl', 'alt', 'shift', 'cmd']

ComputerUseA11yScope

ComputerUseA11yScope = Literal['focused', 'pid', 'all']

ComputerUseA11yNameMatch

ComputerUseA11yNameMatch = Literal['exact', 'substring', 'regex']

ComputerUseDesktopState

ComputerUseDesktopState = Union[Literal['not_started', 'starting', 'ready', 'failed'], str]

ComputerUseDesktopFailureCode

ComputerUseDesktopFailureCode = Literal['desktop_exited', 'addon_crashed', 'start_failed', 'start_interrupted', 'session_ended', 'session_replaced', 'state_corrupt', 'state_persistence_failed', 'unknown']

ComputerUseStatusResponse

ComputerUseStatusResponse = Union[ComputerUseNotStartedStatus, ComputerUseStartingStatus, ComputerUseReadyStatus, ComputerUseFailedStatus]

ComputerUseLifecycleResponse

ComputerUseLifecycleResponse = ComputerUseLifecycleResult

ComputerUseProcessRestartResponse

ComputerUseProcessRestartResponse = ComputerUseProcessRestartResult

ComputerUseProcessLogsResponse

ComputerUseProcessLogsResponse = ComputerUseProcessLogs

ComputerUseProcessErrorsResponse

ComputerUseProcessErrorsResponse = ComputerUseProcessErrors

ComputerUseScreenshotResponse

ComputerUseScreenshotResponse = ComputerUseScreenshot

ComputerUseScrollResponse

ComputerUseScrollResponse = ComputerUseScrollResult

ComputerUseDisplayInfoResponse

ComputerUseDisplayInfoResponse = ComputerUseDisplayInfo

ComputerUseDisplayWindowsResponse

ComputerUseDisplayWindowsResponse = ComputerUseDisplayWindows

ComputerUseA11yTreeResponse

ComputerUseA11yTreeResponse = ComputerUseA11yTree

ComputerUseA11yFindResponse

ComputerUseA11yFindResponse = ComputerUseA11yFindResult

ComputerUseRecordingsResponse

ComputerUseRecordingsResponse = ComputerUseRecordingList

On this page

ComputerUseServiceComputerUseService.__init__ComputerUseService.statusComputerUseService.startComputerUseService.stopComputerUseService.restartAddonProcessesServiceAddonProcessesService.__init__AddonProcessesService.statusAddonProcessesService.statusAddonProcessesService.restartAddonProcessesService.logsAddonProcessesService.errorsMouseServiceMouseService.__init__MouseService.positionMouseService.moveMouseService.clickMouseService.dragMouseService.scrollKeyboardServiceKeyboardService.__init__KeyboardService.typeKeyboardService.keyKeyboardService.hotkeyScreenServiceScreenService.__init__ScreenService.captureScreenService.regionScreenService.capture_compressedScreenService.region_compressedDisplayServiceDisplayService.__init__DisplayService.infoDisplayService.windowsA11yServiceA11yService.__init__A11yService.treeA11yService.findA11yService.focusA11yService.invokeA11yService.set_valueRecordingServiceRecordingService.__init__RecordingService.startRecordingService.stopRecordingService.listRecordingService.getRecordingService.downloadRecordingService.deleteComputerUseDesktopFailureComputerUseNotStartedStatusComputerUseStartingStatusComputerUseReadyStatusComputerUseFailedStatusComputerUseRestartResponseComputerUseProcessStatusComputerUseProcessRunningStatusComputerUsePointComputerUseDisplayComputerUseWindowComputerUseAccessibilityBoundsComputerUseAccessibilityNodeComputerUseRecordingSyncComputerUseServiceSyncComputerUseService.__init__SyncComputerUseService.serviceSyncComputerUseService.mouseSyncComputerUseService.keyboardSyncComputerUseService.screenSyncComputerUseService.displaySyncComputerUseService.a11ySyncComputerUseService.recordingSyncComputerUseService.restartSyncComputerUseService.startSyncComputerUseService.statusSyncComputerUseService.stopSyncA11yServiceSyncA11yService.__init__SyncA11yService.findSyncA11yService.focusSyncA11yService.invokeSyncA11yService.set_valueSyncA11yService.treeSyncAddonProcessesServiceSyncAddonProcessesService.__init__SyncAddonProcessesService.errorsSyncAddonProcessesService.logsSyncAddonProcessesService.restartSyncAddonProcessesService.statusSyncAddonProcessesService.statusSyncDisplayServiceSyncDisplayService.__init__SyncDisplayService.infoSyncDisplayService.windowsSyncKeyboardServiceSyncKeyboardService.__init__SyncKeyboardService.hotkeySyncKeyboardService.keySyncKeyboardService.typeSyncMouseServiceSyncMouseService.__init__SyncMouseService.clickSyncMouseService.dragSyncMouseService.moveSyncMouseService.positionSyncMouseService.scrollSyncRecordingServiceSyncRecordingService.__init__SyncRecordingService.deleteSyncRecordingService.downloadSyncRecordingService.getSyncRecordingService.listSyncRecordingService.startSyncRecordingService.stopSyncScreenServiceSyncScreenService.__init__SyncScreenService.captureSyncScreenService.capture_compressedSyncScreenService.regionSyncScreenService.region_compressedComputerUseMouseButtonComputerUseScrollDirectionComputerUseScreenshotFormatComputerUseKeyboardModifierComputerUseA11yScopeComputerUseA11yNameMatchComputerUseDesktopStateComputerUseDesktopFailureCodeComputerUseStatusResponseComputerUseLifecycleResponseComputerUseProcessRestartResponseComputerUseProcessLogsResponseComputerUseProcessErrorsResponseComputerUseScreenshotResponseComputerUseScrollResponseComputerUseDisplayInfoResponseComputerUseDisplayWindowsResponseComputerUseA11yTreeResponseComputerUseA11yFindResponseComputerUseRecordingsResponse