SoulFire LogoSoulFire

Find blocks

Finds blocks of the given ids within a radius of the bot. Results are sorted by ascending distance.

POST
/v1/instances/{instance_id}/bots/{bot_id}/live/world/blocks:find

Finds blocks of the given ids within a radius of the bot. Results are sorted by ascending distance.

Authorization

AuthorizationBearer <token>

Preferred API authentication. Use a JWT with the api audience.

In: header

Path Parameters

instance_id*string
Formatuuid
bot_id*string
Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

blockIds*array<string>

Block ids to match (namespaced, e.g. "minecraft:diamond_ore"). A block matches if its id equals any entry in this list.

maxDistance*integer

Maximum search radius in blocks, measured from the bot's current block position. Server clamps to an implementation-defined maximum.

Formatint32
maxCount*integer

Maximum number of matches to return. Results are ordered by ascending distance from the bot.

Formatint32

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/live/world/blocks:find" \  -H "Content-Type: application/json" \  -d '{    "blockIds": [      "string"    ],    "maxDistance": 0,    "maxCount": 0  }'
{  "blocks": [    {      "position": {        "x": 0,        "y": 0,        "z": 0,        "dimension": "string"      },      "blockId": "string",      "properties": {        "property1": "string",        "property2": "string"      }    }  ]}

How is this page?