SoulFire LogoSoulFire

Mouse click

Simulates a mouse click in the game world. Left click: attack entity or start breaking block. Right click: use item or interact with entity/block. The bot must be online with valid player, level, and gameMode.

POST
/v1/instances/{instance_id}/bots/{bot_id}/mouse:click

Simulates a mouse click in the game world. Left click: attack entity or start breaking block. Right click: use item or interact with entity/block. The bot must be online with valid player, level, and gameMode.

Authorization

AuthorizationBearer <token>

Preferred API authentication. Use a JWT with the api audience.

In: header

Path Parameters

instance_id*string

The UUID of the SoulFire instance containing the bot.

Formatuuid
bot_id*string

The profile UUID of the bot performing the click.

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Request to simulate a mouse click action in the game world. Used for attacking entities, breaking blocks, using items, and interacting with blocks/entities.

button*string

Which mouse button to simulate clicking.

Value in

  • "MOUSE_BUTTON_UNSPECIFIED"
  • "LEFT_BUTTON"
  • "RIGHT_BUTTON"

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/instances/497f6eca-6276-4993-bfeb-53cbbbba6f08/bots/497f6eca-6276-4993-bfeb-53cbbbba6f08/mouse:click" \  -H "Content-Type: application/json" \  -d '{    "button": "MOUSE_BUTTON_UNSPECIFIED"  }'
{  "success": true,  "error": "string"}

How is this page?

Get inventory state GET

Returns the current state of the bot's open container/inventory. Includes layout information, slot contents, and carried item. The bot must be online with a valid player.

Open inventory POST

Opens the player's inventory screen. Sends a packet to the server to display the inventory UI. The bot must be online with a valid player.