API Reference › Bots — Region & Estate
Return Objects
POST
/bots/{bot_id}/sim/returnReturn objects across the region.
Scopebots:sim
Kick, ban and restart need the bot to be an estate manager in the region.
Usage
curl -X POST "https://api.lifebots.cloud/api/v1/bots/$BOT_ID/sim/return" \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"avatar": "7d1d5c58-2a8f-4c3e-9b11-0a6e5f2c9e41"
}'Path parameters
| Name | Type | Description |
|---|---|---|
bot_id | UUID | The bot's avatar UUID (agentId from GET /bots). |
Body (JSON)
| Name | Type | Required | Description |
|---|---|---|---|
avatar | UUID | no | Only this avatar's objects. |
scripted | boolean | no | Only scripted objects. |
others | boolean | no | Objects on others' land. |
all_estates | boolean | no | Every estate the bot manages. |
Example response
{
"success": true,
"data": {
"result": "OK"
},
"meta": {
"timestamp": "2026-10-02T12:00:00.000Z",
"version": "1.0"
}
} Always check success; for commands the bot carries out, also check data.result. See Responses & errors.