v1

latestSwagger 2.0BSD 3-Clause2026-07-1720953437.1 KB
bots

Get bot

get/bots/{key}

Path parameters

keystring required

The id or name of the bot to retrieve

Query parameters

namestring

Get bot by name

activeboolean

Get bots depending on its active tag

limitinteger

Maximum number of records to return in the response; also useful for pagination in the UI.

offsetinteger

Offset for paginating the response.

Response

Success, returns specified bot

idstring

The UUID for the bot

namestring

The unique readable name for the bot

urlstring

The URL of the bot server

activeboolean

Flag for if a bot is active with communication

actionsobject[]

A list of actions that a bot can perform

dataobject[]

A list of data that a bot can provide

installedBystring

The user who installed the bot