Agents

Get a BotInstance (v2)

Returns one BotInstance by id. Readable by the agent's owner, whoever manages the bot's App (its creator, an admin with appSettings.read, a B2B Server JWT for it) and isSuperAdmin.read; anyone else gets 404. Supports User JWT and B2B Server JWT.

get/v2/bot-instances/{id}

Request

  • Base URL: https://api.chat.ethora.com
  • URL: https://api.chat.ethora.com/v2/bot-instances/{id}
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Path parameters

idstring required

BotInstance id

Response

{ ok: true, botInstance: { id, agentId, appId, userId, xmppUsername, status, joinedRooms, lastActiveAt, createdAt, updatedAt } }

Changes

No recorded changes to this operation across all 1 revision of this API.