Skip to content

Slash command builder

slash_command_builder

Used to create a slash command.

Schema fields #

Key Type Description
name String The name of the slash command.
description String The description of the slash command.
options List of Option schemas The sub-options of the slash command.

Option#

slash_command_option

There are two things this can do, depending on the type:

Either add subcommand literals, or parameters to the command. Sub command groups are always on the first "layer", while subcommands are always one layer deeper than sub command groups.

Note that this is quite limited in comparison to Minecraft commands. All paths of the command tree have to have either just a subcommand, or a subcommand group with subcommands each. This means that the length of the command chains (without the other options that aren't subcommands) has to be equal for all subcommands.

For more info, check this documentation.

Schema fields #

Key Type Description
type String The type of slash command option.
name String The name of the option.
description String The description of the option.
required Boolean
(false by default)
Whether this option is required to be specified.
autocomplete Boolean
(false by default)
Whether this option should autocomplete.
options List of Option schemas Sub-options to this sub-command/group.1
choices List of Option choice object Autocompletable choices for this command option.

Option types#

String Description
sub_command A subcommand
sub_command_group A subcommand group for containing subcommands as options
string Any string
integer Any integer between -2^53 and 2^53
boolean true or false
user Select a user
channel All channel types + categories
role Select a role
mentionable Select a user/role
number A double value
attachment Upload an attachment

Option choice#

slash_command_option_choice

Key Type Description
name String The visible autocompleted filled in choice for the option.
value String The value that will be received in the slash command event as the option value.

  1. Only for SUB_COMMAND and SUB_COMMAND_GROUP types.