SoulFire LogoSoulFire

Set movement state

Updates the bot's movement state (WASD, jump, sneak, sprint). Only specified fields are changed; omitted fields retain their current value. Movement persists until explicitly changed or reset. The action is queued and executed on the next game tick.

POST
/v1/instances/p0/bots/p1/movement:set

Updates the bot's movement state (WASD, jump, sneak, sprint). Only specified fields are changed; omitted fields retain their current value. Movement persists until explicitly changed or reset. The action is queued and executed on the next game tick.

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 to control.

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

forward?boolean

W key state - move forward. true = pressing W, false = not pressing W

backward?boolean

S key state - move backward. true = pressing S, false = not pressing S

left?boolean

A key state - strafe left. true = pressing A, false = not pressing A

right?boolean

D key state - strafe right. true = pressing D, false = not pressing D

jump?boolean

Space key state - jump. true = pressing Space, false = not pressing Space When held, the bot will jump repeatedly.

sneak?boolean

Shift key state - sneak/crouch. true = sneaking, false = not sneaking While sneaking: slower movement, won't fall off edges, crouching animation.

sprint?boolean

Ctrl key state - sprint. true = sprinting, false = not sprinting Requires forward movement and sufficient hunger (food level >= 6).

Response Body

application/json

application/json

application/json

application/json

curl -X POST "http://127.0.0.1:38765/v1/instances/p0/bots/p1/movement:set" \  -H "Content-Type: application/json" \  -d '{}'
{  "success": true,  "error": "string"}

How is this page?