Introduction

Bytebot REST API

Bytebot’s core functionality is exposed through its REST API, which provides endpoints for interacting with the desktop environment. The API allows for programmatic control of mouse movement, keyboard input, and screen capture.

Base URL

All API endpoints are relative to the base URL:

http://localhost:9990

The port can be configured when running the container.

Authentication

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

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:

Status Code	Description
200	Success
400	Bad Request - Invalid parameters
500	Internal Server Error

Available Endpoints

Computer Use

Execute desktop automation actions like mouse movements, clicks, keyboard input, and screenshots

Input Tracking

Control and stream keyboard and mouse events from the desktop

Usage Examples

Code examples and snippets for common automation scenarios

Rate Limiting

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

Getting Started

User Guides

Deployment

Core Concepts

Bytebot REST API

Base URL

Authentication

Response Format

Error Handling

Available Endpoints

Computer Use

Input Tracking

Usage Examples

Rate Limiting

​Bytebot REST API

​Base URL

​Authentication

​Response Format

​Error Handling

​Available Endpoints

Computer Use

Input Tracking

Usage Examples

​Rate Limiting

Bytebot REST API

Base URL

Authentication

Response Format

Error Handling

Available Endpoints

Rate Limiting