Bots
List
Retrieve a paginated list of the bots in a CometChat app using the REST API, with search and AI bot filtering.
GET
List
searchKey matches the start of a bot’s UID, not its name. Results are ordered by UID.
perPage defaults to 100 and is capped at 1000. Page through the results rather than assuming one response holds every bot.
Listing AI bots
isAIBot defaults to false, so this endpoint returns standard bots only. Pass isAIBot=true to list bots flagged as AI bots instead — there is no call that returns both at once.
Agents created through AI Agents are not returned either way.
A GET /bots?isAIBot=true response looks like this:
isAIBot appears only when it is true, because responses omit every property whose value is empty or false. That is also why order-bot in the response example has no useBasicAuth, username or password.
For the complete error reference, see Error Guide.