Skip to main content
GET
Get
Returns ERR_BOT_NOT_FOUND when no bot exists with this UID. That includes a UID that belongs to a user who is not a bot, and an agent created through AI Agents. Responses omit every property whose value is empty or false, so a standard bot has no isAIBot, and a bot that has never had basic auth has no useBasicAuth, username or password. A bot whose useBasicAuth was set to false after it was saved still returns its stored username and password. For a bot flagged as an AI bot, the response includes the flag:
The API returns the stored password value as it was saved, including after useBasicAuth is set to false. The example masks it as ********.
For the complete error reference, see Error Guide.

Authorizations

apikey
string
header
required

API Key with fullAccess scope(i.e. Rest API Key from the Dashboard).

Path Parameters

uid
string
required

An UID of a bot.

Response

200 - application/json

Fetched the bot

data
object