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).
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).
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.
The unique identifier (UUID) of the instance to scope commands to. Must be a valid UUID string.
uuidThe unique identifier (UUID) of the instance containing the bot. Must be a valid UUID string.
uuidThe unique identifier (UUID) of the bot (profile ID) to scope commands to. Must be a valid UUID string matching the bot's account profile ID.
uuidThe partial command string to complete. May be an incomplete command that the user is typing, e.g., "mov" or "move 100 ".
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.
int32Response Body
application/json
application/json
application/json
application/json
curl -X POST "http://127.0.0.1:38765/v1/commands:complete" \ -H "Content-Type: application/json" \ -d '{ "command": "", "cursor": 0 }'{ "suggestions": [ { "suggestion": "string", "tooltip": "string" } ]}{ "code": 0, "grpc-code": "string", "message": "string", "stack-trace": "string", "details": [ {} ]}{ "code": 0, "grpc-code": "string", "message": "string", "stack-trace": "string", "details": [ {} ]}{ "code": 0, "grpc-code": "string", "message": "string", "stack-trace": "string", "details": [ {} ]}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.