List commands

GET

/api/v1/commands

const url = 'http://localhost:11044/api/v1/commands';
const options = {method: 'GET', headers: {'X-Embabel-Api-Key': '<X-Embabel-Api-Key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url http://localhost:11044/api/v1/commands \
  --header 'X-Embabel-Api-Key: <X-Embabel-Api-Key>'

Returns all action commands configured in the user’s world.

Authorizations

apiKeyAuth
basicAuth

Responses

200

List of commands

*/*

Array<object>

A slash command that runs a world action when a chat message starts with it. Listed by GET /commands and saved by POST /commands

object

actionName

required

Name of the world action the command runs. Text typed after the command word becomes the action’s input; with none, the action runs directly if it takes no input and otherwise asks for it with a form

string

command

required

The command word without its leading slash, matched case-insensitively. Also the file name it is saved under, so saving one that exists replaces it

string

description

required

The message shown with that input form. Empty when not set

string