SoulFire LogoSoulFire

Reset movement

Resets all movement to stopped state. Equivalent to releasing all movement keys. The action is queued and executed on the next game tick.

POST
/v1/instances/{instance_id}/bots/{bot_id}/movement:reset

Resets all movement to stopped state. Equivalent to releasing all movement keys. 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 stop movement for.

Formatuuid

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/movement:reset"
{  "success": true,  "error": "string"}

How is this page?

Render bot POV GET

Renders the bot's point-of-view as a PNG image using headless Vulkan. The bot must be online with a valid player and level. Uses the bot's current render distance setting.

Restart bots POST

Forces the selected bots to establish fresh connections.