Mouse Scroll

Description

Performs a mouse scroll operation at specified coordinates with a given number of clicks in the specified direction. This allows an agent to scroll content in a window or webpage to reveal more information or navigate through a document.

The endpoint moves the cursor to the specified (X, Y) coordinates and then performs scroll wheel operations in the direction specified. The number of clicks parameter controls how much scrolling occurs, with more clicks resulting in more scrolling.

Scrolling is particularly useful for interacting with:

• Long web pages
• Document viewers
• Lists and dropdowns
• Any interface with content that extends beyond the visible area

Request Format

This endpoint accepts a POST request with a JSON object containing coordinates, direction, and the number of scrolling clicks to perform.

{
    "x": number,       // X coordinate on the screen
    "y": number,       // Y coordinate on the screen
    "clicks": number,  // Number of scroll wheel clicks to execute
    "direction": string // "up" or "down" (default: "down")
}
            

Parameters

Example Request

{
  "x": 500,
  "y": 300,
  "clicks": 3,
  "direction": "down"
}

Response Format

The response includes information about whether the scroll operation was successful, a message describing the action, and a timestamp.

{
    "Success": boolean,    // Whether the operation was successful
    "Message": "string",   // Result message or error description
    "Timestamp": "string"  // ISO timestamp of the operation
}
            

Response Fields

Example Response

{
  "Success": true,
  "Message": "Mouse scrolldown executed at coordinates (500, 300)",
  "Timestamp": "2023-07-15T14:30:22.123Z"
}

Code Examples

import requests
import json

url = "http://localhost:54321/tools-api/mouse/scroll"
headers = {
    "Content-Type": "application/json",
    "Authorization": "Bearer YOUR_API_KEY"
}
payload = {
    "x": 500,
    "y": 300,
    "clicks": 3,
    "direction": "down"
}

response = requests.post(url, headers=headers, data=json.dumps(payload))
print(response.json())

import axios from 'axios';

const scrollMouse = async () => {
  try {
    const response = await axios.post('http://localhost:54321/tools-api/mouse/scroll', {
      x: 500,
      y: 300,
      clicks: 3,
      direction: 'down'
    }, {
      headers: {
        'Content-Type': 'application/json',
        'Authorization': 'Bearer YOUR_API_KEY'
      }
    });
    
    console.log(response.data);
  } catch (error) {
    console.error('Error performing mouse scroll:', error);
  }
}

scrollMouse();

using System;
using System.Net.Http;
using System.Text;
using System.Text.Json;
using System.Threading.Tasks;

public class ScrollMouseExample
{
    public static async Task Main()
    {
        using (var client = new HttpClient())
        {
            client.DefaultRequestHeaders.Add("Authorization", "Bearer YOUR_API_KEY");
            
            var payload = new
            {
                x = 500,
                y = 300,
                clicks = 3,
                direction = "down"
            };
            
            var content = new StringContent(
                JsonSerializer.Serialize(payload),
                Encoding.UTF8,
                "application/json");
                
            var response = await client.PostAsync(
                "http://localhost:54321/tools-api/mouse/scroll",
                content);
                
            var responseBody = await response.Content.ReadAsStringAsync();
            Console.WriteLine(responseBody);
        }
    }
}

Examples

Basic Scrolling

Scrolling down a webpage to reveal more content:

{
  "x": 500,
  "y": 300,
  "clicks": 3,
  "direction": "down"
}

Scrolling Up

Scrolling back up to the top of a document:

{
  "x": 500,
  "y": 300,
  "clicks": 5,
  "direction": "up"
}

Scrolling with Many Clicks

Scrolling a long distance to reach the bottom of a page:

{
  "x": 500,
  "y": 300,
  "clicks": 10,
  "direction": "down"
}