Bot Live Service

Acquire bot control POST Attack entity POST Dig block POST Dismount POST Find blocks POST Get block GET Interact with block POST Interact with entity POST List nearby entities GET Mount entity POST Place block POST Release bot control POST Release item POST Renew bot control POST Respawn bot POST Respond to resource pack POST Send chat POST Set creative slot POST Set flying state POST Set vehicle control POST Sleep in bed POST Start elytra flight POST Stop pathfinding POST Swing arm POST Update sign POST Use item POST Wait for chunks POST Wake from bed POST Write book POST

Bot Protocol Service

Get bot protocol information GET List negotiated packet schemas GET Send a raw Minecraft packet POST

Bot Service

Click container button POST Click dialog button POST Click inventory slot POST Close container POST Close dialog POST Get bot GET List bots GET Get bot world map GET Get dialog GET Get inventory state GET Mouse click POST Open inventory POST Render bot POV GET Reset movement POST Restart bots POST Set bot desired state POST Set container text POST Select hotbar slot POST Set movement state POST Set bot rotation POST Submit dialog POST Update bot config entry PATCH

Bot Task Service

Cancel bot task POST Get bot task GET List bot tasks GET Start bot task POST

Chat Service

Send command POST Send public chat POST Send whisper POST Complete command or chat POST

Client Service

Generate API token POST Generate WebDAV token POST Get client data GET Invalidate self sessions POST Update self email PATCH Update self username PATCH

Command Service

Execute command POST Complete command POST

Download Service

Download URL POST

Instance Service

Add instance account POST Batch add instance accounts POST Batch add instance proxies POST Add instance proxy POST List instances GET Create instance POST Delete account metadata entry DELETE Set account metadata entry PUT Get instance GET Delete instance DELETE Delete instance metadata entry DELETE Set instance metadata entry PUT Get account metadata GET Get audit log GET Get instance metadata GET Remove instance account DELETE Batch remove instance accounts POST Batch remove instance proxies POST Remove instance proxy DELETE Update instance proxy PUT Update instance account POST Update instance config PATCH Update instance config entry PUT Update instance metadata PATCH

Inventory Service

Close container POST Count inventory items POST Equip item POST Find inventory slots POST Get container snapshot POST Move inventory item POST Open block container POST Rank inventory items POST Select hotbar item POST Toss inventory items POST Transfer items POST Unequip item POST

Login Service

Verify email code POST Start login flow POST

Logs Service

Get log history POST

M C Auth Service

Refresh Minecraft account POST

Metrics Service

Get instance metrics GET Get server metrics GET

Pathfinder Service

Plan bot path POST

Plugin Api Service

Get plugin API GET Download plugin descriptor set GET List plugin APIs GET

Plugin Stats Service

Get instance plugin stats GET

Recipe Service

Check recipe materials POST List recipes GET List villager trades GET

Registry Service

Get registry entry GET Get registry identity GET List registry entries GET List registry tags GET

Script Service

List scripts GET Create script POST Deactivate script POST Get script GET Update script PATCH Delete script DELETE Get node types GET Get script registry data GET Get script status GET Validate script POST

Sdk Service

Negotiate SDK connection POST

Server Service

Get server info GET Update server config PATCH Update server config entry PUT

User Service

List users GET Create user POST Get user GET Update user PATCH Delete user DELETE Delete user plugin permission grant DELETE Set user plugin permission grant PUT Generate user API token POST Invalidate user sessions POST List user plugin permission grants GET

World Service

Check block visibility POST Estimate block dig time POST Estimate explosion damage POST Get player snapshot GET Get world block GET Get world entity GET Query blocks POST Query entities POST Raycast world POST

API Reference

View the generated reference for SoulFire's HTTP API.

Use this section to connect to SoulFire over HTTP. SoulFire generates these pages from its OpenAPI schema. The sidebar groups the pages by tag.

Use Development for Fabric plugins, Mixins, or direct access to SoulFire and Minecraft classes. Use this section for the HTTP API.

What is here

Endpoint pages with parameters, request bodies, responses, and examples
The HTTP/JSON API for remote automation and integrations
The raw schema at /sf-openapi.json

Use the sidebar to open an API tag or operation.

How is this page?

Sponsored

Need a more capable admin panel for your server?

EnderDash adds an advanced dashboard to your existing Minecraft servers with a single plugin, batteries included.

Check out EnderDash

Last updated on

Acquire bot control POST

Acquires exclusive action control for a bot. While the lease is active, action calls must include its token in the X-SoulFire-Control-Token request header.

On this page