API Reference

​

Computer Use API

Bytebot’s core functionality is exposed through its Computer Use API, which provides a unified endpoint for all interactions with the desktop environment. The API allows for programmatic control of mouse movement, keyboard input, and screen capture.

​

Authentication

The Bytebot API does not require authentication by default when accessed locally. For remote access, standard network security practices should be implemented.

​

Base URL

All API endpoints are relative to the base URL:

http://localhost:9990

The port can be configured when running the container.

​

API Endpoints

​

Response Format

All API responses follow a standard JSON format:

{
  "success": true,
  "data": { ... },  // Response data specific to the action
  "error": null     // Error message if success is false
}

​

Error Handling

When an error occurs, the API returns:

{
  "success": false,
  "data": null,
  "error": "Detailed error message"
}

Common HTTP status codes:

​

Rate Limiting

The API currently does not implement rate limiting, but excessive requests may impact performance of the virtual desktop environment.