List bots
Returns a list of all bots configured in the specified instance. Includes both online and offline bots with their current status. For online bots, includes live state (position, health, etc.) but NOT full inventory data.
Returns a list of all bots configured in the specified instance. Includes both online and offline bots with their current status. For online bots, includes live state (position, health, etc.) but NOT full inventory data.
Preferred API authentication. Use a JWT with the api audience.
In: header
Path Parameters
The UUID of the SoulFire instance to list bots from. Must be a valid UUID string format.
uuidResponse Body
application/json
application/json
application/json
application/json
curl -X GET "http://127.0.0.1:38765/v1/instances/:instance_id/bots"{
"bots": [
{
"profile_id": "string",
"is_online": true,
"live_state": {
"x": 0.1,
"y": 0.1,
"z": 0.1,
"xRot": 0.1,
"yRot": 0.1,
"health": 0.1,
"max_health": 0.1,
"food_level": 0,
"saturation_level": 0.1,
"inventory": [
{
"slot": 0,
"item_id": "string",
"count": 0,
"display_name": "string"
}
],
"selected_hotbar_slot": 0,
"dimension": "string",
"experience_level": 0,
"experience_progress": 0.1,
"skin_texture_hash": "string",
"game_mode": "GAME_MODE_UNSPECIFIED"
}
}
]
}{
"code": 0,
"grpc-code": "string",
"message": "string",
"stack-trace": "string",
"details": [
{}
]
}{
"code": 0,
"grpc-code": "string",
"message": "string",
"stack-trace": "string",
"details": [
{}
]
}{
"code": 0,
"grpc-code": "string",
"message": "string",
"stack-trace": "string",
"details": [
{}
]
}How is this page?
Get bot GET
Returns detailed information about a specific bot. Includes full live state with complete inventory data when the bot is online.
Get dialog GET
Returns the currently displayed server dialog (Minecraft 1.21.6+). Dialogs are server-sent UI screens for custom interactions. Returns empty response if no dialog is being shown. Does not require the bot to be online (but dialog will be absent).