SoulFire LogoSoulFire

Complete command

Retrieves tab-completion suggestions for a partial command. Uses Brigadier's completion system to generate context-aware suggestions based on the command structure and current cursor position. Permission requirements depend on the scope (same as ExecuteCommand).

POST
/v1/commands:complete

Retrieves tab-completion suggestions for a partial command. Uses Brigadier's completion system to generate context-aware suggestions based on the command structure and current cursor position.

Permission requirements depend on the scope (same as ExecuteCommand).

Authorization

AuthorizationBearer <token>

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

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Request message for getting tab-completion suggestions for a partial command.

scope*

The execution scope that determines which instances/bots are visible for completion suggestions. Must be set to one of the scope options.

command*string

The partial command string to complete. May be an incomplete command that the user is typing, e.g., "mov" or "move 100 ".

cursor*integer

The cursor position within the command string (0-indexed). Completions will be generated for the token at this position. Typically this is the length of the command string for end-of-line completion.

Formatint32

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/commands:complete" \  -H "Content-Type: application/json" \  -d '{    "command": "",    "cursor": 0  }'
{  "suggestions": [    {      "suggestion": "string",      "tooltip": "string"    }  ]}

How is this page?

Execute command POST

Executes a command string within the specified scope. The command is parsed and executed using the Brigadier command dispatcher. Permission requirements depend on the scope: - Global scope: Requires GLOBAL_COMMAND_EXECUTION permission - Instance scope: Requires INSTANCE_COMMAND_EXECUTION for the instance - Bot scope: Requires INSTANCE_COMMAND_EXECUTION for the parent instance

Download URL POST

Downloads content from the specified URI and returns the response. Makes an HTTP GET request to the URI specified in the request, optionally routing through a proxy. Custom headers can be provided to customize the request.