SoulFire LogoSoulFire

Wait for chunks

Waits until every chunk in a square radius around the bot is loaded.

POST
/v1/instances/{instance_id}/bots/{bot_id}/chunks:wait

Waits until every chunk in a square radius around the bot is loaded.

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.

radiusChunks?integer

Chebyshev radius around the bot's current chunk. Zero waits for only the current chunk. The server rejects values above its safety limit.

Formatint64
Range0 <= value <= 4294967295
timeoutMs?integer

Maximum wait in milliseconds. Zero uses the server default.

Formatint64
Range0 <= value <= 4294967295

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/chunks:wait" \  -H "Content-Type: application/json" \  -d '{}'
{  "centerChunkX": 0,  "centerChunkZ": 0,  "loadedChunks": 0,  "requiredChunks": 0,  "dimension": "string"}

How is this page?