Skip to main content

computer-use-api

AgentKit Computer-Use API

This Python package is automatically generated by the Swagger Codegen project:

  • API version: 0.0.1
  • Package version: 0.0.2
  • Build package: io.swagger.codegen.v3.generators.python.PythonClientCodegen

Requirements.

Python 2.7 and 3.4+

Installation & Usage

pip install

pip install computer-use-api

(you may need to run pip with root permission: sudo pip install computer-use-api)

Then import the package:

import computer_use_api 

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import computer_use_api

Getting Started

Please follow the installation procedure and then run the following:

from __future__ import print_function
import time
import computer_use_api
from computer_use_api.rest import ApiException
from pprint import pprint

# Configure API key authorization: ComputerUseKey
configuration = computer_use_api.Configuration()
configuration.host = "YOUR_TOOL_SERVER_URL"
configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# create an instance of the API class
api_instance = computer_use_api.ComputerUseApi(computer_use_api.ApiClient(configuration))
body = computer_use_api.ClickMouseRequest() # ClickMouseRequest | 

try:
    # 鼠标在指定位置点击
    api_response = api_instance.click_mouse(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ComputerUseApi->click_mouse: %s\n" % e)

# Configure API key authorization: ComputerUseKey
configuration = computer_use_api.Configuration()
configuration.host = "YOUR_TOOL_SERVER_URL"
configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# create an instance of the API class
api_instance = computer_use_api.ComputerUseApi(computer_use_api.ApiClient(configuration))
body = computer_use_api.DragMouseRequest() # DragMouseRequest | 

try:
    # 移动鼠标
    api_response = api_instance.drag_mouse(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ComputerUseApi->drag_mouse: %s\n" % e)

# Configure API key authorization: ComputerUseKey
configuration = computer_use_api.Configuration()
configuration.host = "YOUR_TOOL_SERVER_URL"
configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# create an instance of the API class
api_instance = computer_use_api.ComputerUseApi(computer_use_api.ApiClient(configuration))

try:
    # 获取鼠标坐标
    api_response = api_instance.get_cursor_position()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ComputerUseApi->get_cursor_position: %s\n" % e)

# Configure API key authorization: ComputerUseKey
configuration = computer_use_api.Configuration()
configuration.host = "YOUR_TOOL_SERVER_URL"
configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# create an instance of the API class
api_instance = computer_use_api.ComputerUseApi(computer_use_api.ApiClient(configuration))

try:
    # 获取屏幕长宽
    api_response = api_instance.get_screen_size()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ComputerUseApi->get_screen_size: %s\n" % e)

# Configure API key authorization: ComputerUseKey
configuration = computer_use_api.Configuration()
configuration.host = "YOUR_TOOL_SERVER_URL"
configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# create an instance of the API class
api_instance = computer_use_api.ComputerUseApi(computer_use_api.ApiClient(configuration))
body = computer_use_api.MoveMouseRequest() # MoveMouseRequest | 

try:
    # 鼠标移动到指定位置
    api_response = api_instance.move_mouse(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ComputerUseApi->move_mouse: %s\n" % e)

# Configure API key authorization: ComputerUseKey
configuration = computer_use_api.Configuration()
configuration.host = "YOUR_TOOL_SERVER_URL"
configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# create an instance of the API class
api_instance = computer_use_api.ComputerUseApi(computer_use_api.ApiClient(configuration))
body = computer_use_api.PressKeyRequest() # PressKeyRequest | 

try:
    # 按键
    api_response = api_instance.press_key(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ComputerUseApi->press_key: %s\n" % e)

# Configure API key authorization: ComputerUseKey
configuration = computer_use_api.Configuration()
configuration.host = "YOUR_TOOL_SERVER_URL"
configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# create an instance of the API class
api_instance = computer_use_api.ComputerUseApi(computer_use_api.ApiClient(configuration))
body = computer_use_api.ScrollRequest() # ScrollRequest | 

try:
    # 滚动
    api_response = api_instance.scroll(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ComputerUseApi->scroll: %s\n" % e)

# Configure API key authorization: ComputerUseKey
configuration = computer_use_api.Configuration()
configuration.host = "YOUR_TOOL_SERVER_URL"
configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# create an instance of the API class
api_instance = computer_use_api.ComputerUseApi(computer_use_api.ApiClient(configuration))

try:
    # 截屏
    api_response = api_instance.take_screenshot()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ComputerUseApi->take_screenshot: %s\n" % e)

# Configure API key authorization: ComputerUseKey
configuration = computer_use_api.Configuration()
configuration.host = "YOUR_TOOL_SERVER_URL"
configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# create an instance of the API class
api_instance = computer_use_api.ComputerUseApi(computer_use_api.ApiClient(configuration))
body = computer_use_api.TypeTextRequest() # TypeTextRequest | 

try:
    # 发送文本
    api_response = api_instance.type_text(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ComputerUseApi->type_text: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to /

Class Method HTTP request Description
ComputerUseApi click_mouse POST /2020-04-01/ClickMouse 鼠标在指定位置点击
ComputerUseApi drag_mouse POST /2020-04-01/DragMouse 移动鼠标
ComputerUseApi get_cursor_position GET /2020-04-01/GetCursorPosition 获取鼠标坐标
ComputerUseApi get_screen_size GET /2020-04-01/GetScreenSize 获取屏幕长宽
ComputerUseApi move_mouse POST /2020-04-01/MoveMouse 鼠标移动到指定位置
ComputerUseApi press_key POST /2020-04-01/PressKey 按键
ComputerUseApi scroll POST /2020-04-01/Scroll 滚动
ComputerUseApi take_screenshot GET /2020-04-01/TakeScreenshot 截屏
ComputerUseApi type_text POST /2020-04-01/TypeText 发送文本

Documentation For Models

Documentation For Authorization

ComputerUseKey

  • Type: API key
  • API key parameter name: X-API-Key
  • Location: HTTP header

Author

Metadata

Release files for computer-use-api 0.0.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for computer-use-api 0.0.2
File Size Uploaded Provenance Actions
computer_use_api-0.0.2.tar.gz 24.0 kB Without provenance Details for computer_use_api-0.0.2.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for computer-use-api 0.0.2
File Interpreter ABI Platform Actions
computer_use_api-0.0.2-py3-none-any.whl Python 3 none any Details for computer_use_api-0.0.2-py3-none-any.whl

Total release size: 72.8 kB

Release files / computer_use_api-0.0.2.tar.gz

Download URL computer_use_api-0.0.2.tar.gz
Size 24.0 kB
Tags Source
SHA-256 checksum
How to use checksums
36aa0ed62127009513fc61c4c887e95dfc921ea91cc90989e3267546f9966fda
BLAKE2b-256 checksum
How to use checksums
b56a33a0d52105b1df09b4c1b5e4913d0f6339d2ba6a9eea09a2301e527a1a1e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.5

Release files / computer_use_api-0.0.2-py3-none-any.whl

Download URL computer_use_api-0.0.2-py3-none-any.whl
Size 48.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
564e5d5ce2a72a71ba383e8189d2c2a7ea0b36a60e6e5e9d458e6c1f950c6f67
BLAKE2b-256 checksum
How to use checksums
91f9ea8ccb21059baa153209c44307b834ab3e8176e62d94c1cc856c6dd180d4
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.5

Security for computer-use-api 0.0.2

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.0.2 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page