chatbot

Add/Update a custom command for a broadcaster

This endpoint adds a new custom command for a broadcaster. If the name matches an existing command for that broadcaster, it will update the command in-place.

POST/chatbot/commands

Header parameters

Body

application/json

Body

name*string

aliasesarray of string

global_cooldownnumber

user_cooldownnumber

privilegesarray of enum

template*string

Response

200

200

Request

JavaScriptCurlPython

const response = await fetch('/chatbot/commands', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text",
      "template": "text"
    }),
});
const data = await response.json();

Delete broadcaster command by ID

This will also delete all associated records with this command, such as message trigger thresholds and timer triggers.

DELETE/chatbot/commands

Header parameters

Body

application/json

Body

commandId*string

Response

204

204

Request

JavaScriptCurlPython

const response = await fetch('/chatbot/commands', {
    method: 'DELETE',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "commandId": "text"
    }),
});
const data = await response.json();

Get broadcaster commands

Get default and custom commands that are enabled for the authenticated broadcaster. Default commands can be filtered out with the custom parameter to only show custom commands

GET/chatbot/commands

Query parameters

Header parameters

Response

200

200

Body

application/json

commands*array of object

messageThresholds*array of object

Request

JavaScriptCurlPython

const response = await fetch('/chatbot/commands', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "commands": [
    {
      "id": "text",
      "name": "text",
      "broadcaster_id": "text",
      "aliases": [
        "text"
      ],
      "global_cooldown": 0,
      "user_cooldown": 0,
      "privileges": [
        0
      ],
      "template": "text",
      "category": "default",
      "requires_premium": false,
      "disabled": false,
      "unlisted": false
    }
  ],
  "messageThresholds": [
    {
      "command_id": "text",
      "trigger_threshold_amount": 0
    }
  ]
}

Adds a new broadcaster command threshold

POST/chatbot/thresholds

Header parameters

Body

application/json

Body

commandId*string

triggerThresholdAmount*number

Response

201404

201

Request

JavaScriptCurlPython

const response = await fetch('/chatbot/thresholds', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "commandId": "text",
      "triggerThresholdAmount": 0
    }),
});
const data = await response.json();

Delete broadcaster command threshold

This will delete a specific message threshold trigger for a custom command.

DELETE/chatbot/thresholds

Header parameters

Body

application/json

Body

commandId*string

Response

204404

204

Request

JavaScriptCurlPython

const response = await fetch('/chatbot/thresholds', {
    method: 'DELETE',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "commandId": "text"
    }),
});
const data = await response.json();

Get a specific broadcaster command by ID

Get a specific broadcaster command by ID. The response will include the command's ID, name, description, response text and other supplemental settings.

GET/chatbot/commands/{id}

Path parameters

id*string

Header parameters

Response

200404

200

Request

JavaScriptCurlPython

const response = await fetch('/chatbot/commands/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Get chatbot variables

Get variables that are available to the current broadcaster. Some variables are only available to premium

GET/chatbot/variables

Header parameters

Response

200

200

Body

application/json

name*string

templateValue*string

requiresPremium*boolean

Request

JavaScriptCurlPython

const response = await fetch('/chatbot/variables', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

[
  {
    "name": "text",
    "templateValue": "text",
    "requiresPremium": false
  }
]

Toggle enable or disable a chatbot command.

This endpoint allows users to toggle the enabled/disabled state of a chatbot command. The endpoint accepts a command name and a boolean enabled, and returns a success message if the command's state is successfully updated. If the command is not found, a 404 error is returned. The endpoint requires authentication and uses the impersonating channel ID or the user's ID to determine the broadcaster ID.

POST/chatbot/commands/toggle-enable

Header parameters

Body

application/json

Body

commandName*string

enabled*boolean

Response

204404

204

Request

JavaScriptCurlPython

const response = await fetch('/chatbot/commands/toggle-enable', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "commandName": "text",
      "enabled": false
    }),
});
const data = await response.json();