SoulFire LogoSoulFire

Click inventory slot

Performs a click action on an inventory/container slot. Supports various click types (left, right, shift, drop, swap, middle). The bot must be online with a valid player and gameMode.

POST
/v1/instances/p0/bots/p1/inventory/slots/p2:click

Performs a click action on an inventory/container slot. Supports various click types (left, right, shift, drop, swap, middle). The bot must be online with a valid player 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 inventory action.

Formatuuid
slot*integer

The slot index to click. Valid range depends on the currently open container. Special value: -999 for clicking outside the inventory (dropping items).

Formatint32

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

click_type*

The type of click to perform. Different click types have different effects on items.

hotbar_slot*integer

For SWAP_HOTBAR click type: which hotbar slot to swap with. Range: 0-8 (corresponding to hotbar slots 1-9). Ignored for other click types.

Formatint32

Response Body

application/json

application/json

application/json

application/json

curl -X POST "http://127.0.0.1:38765/v1/instances/p0/bots/p1/inventory/slots/p2:click" \  -H "Content-Type: application/json" \  -d '{    "click_type": {},    "hotbar_slot": 0  }'
{  "success": true,  "error": "string"}

How is this page?

Click dialog button POST

Clicks a button in the current dialog. Button index depends on dialog type (see BotClickDialogButtonRequest). The dialog is typically closed after the button click. Note: Full dialog button packets are not yet implemented; this clears local state.

Close container POST

Closes the currently open container (chest, crafting table, etc.). Returns to the player inventory view. The bot must be online with a valid player.