Get bot

Returns detailed information about a specific bot. Includes full live state with complete inventory data when the bot is online.

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. Must be a valid UUID string format (e.g., "550e8400-e29b-41d4-a716-446655440000").

Formatuuid

bot_id*string

The profile UUID of the bot (Minecraft account UUID). Must be a valid UUID string format.

Formatuuid

Response Body

`application/json`

curl -X GET "http://127.0.0.1:38765/v1/instances/:instance_id/bots/:bot_id"

{
  "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": [
    {}
  ]
}

Authorization

Path Parameters

Response Body

200application/json

401application/json

403application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`