SoulFire LogoSoulFire

Render bot POV

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

GET
/v1/instances/p0/bots/p1/pov:render

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

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 render POV for.

Formatuuid

Query Parameters

width*integer

Desired image width in pixels. Default: 854 (if 0 or not provided). Maximum: 1920 (values above this are clamped). Minimum: 1 (values below this are clamped).

Formatint32
height*integer

Desired image height in pixels. Default: 480 (if 0 or not provided). Maximum: 1080 (values above this are clamped). Minimum: 1 (values below this are clamped).

Formatint32

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://127.0.0.1:38765/v1/instances/p0/bots/p1/pov:render?width=0&height=0"
{
  "image_base64": "string"
}
{
  "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?

Open inventory POST

Opens the player's inventory screen. Sends a packet to the server to display the inventory UI. The bot must be online with a valid player.

Reset movement POST

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