SoulFire LogoSoulFire

Set container text

Sets text in a container's text input field. Currently only supports anvil item renaming (field_id: "item_name"). The action is queued and executed on the next game tick.

POST
/v1/instances/{instance_id}/bots/{bot_id}/container/text-inputs/{field_id}:set

Sets text in a container's text input field. Currently only supports anvil item renaming (field_id: "item_name"). The action is queued and executed on the next game tick.

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 setting the text.

Formatuuid
field_id*string

Which field to set the text for. Currently supported: "item_name" (anvil rename)

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Request to set text in a container text input field. Currently only supports anvil item renaming.

text*string

The text value to set. For anvil: max 50 characters for the item name.

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/container/text-inputs/string:set" \  -H "Content-Type: application/json" \  -d '{    "text": "string"  }'
{  "success": true,  "error": "string"}

How is this page?

Set bot desired state POST

Persists whether the selected bots should be running or stopped. The request returns after the desired state is durable. Connections are reconciled asynchronously and can be observed through WatchBotStatuses.

Select hotbar slot POST

Changes the selected hotbar slot. Valid slot range: 0-8 (corresponding to slots 1-9 in the UI). The action is queued and executed on the next game tick.