Agents

Diagnostics for one BotInstance of an AI Agent (v2)

Returns the stored BotInstance plus the AI service's live view of it (XMPP connected or not, joined rooms, last error, recent conversations). When the AI service cannot be reached the call still succeeds, with aiService: null and the reason in aiServiceError.

For a private agent, owner only. For someone else's public agent, only bots in Apps the caller manages (403 otherwise). Supports User JWT and B2B Server JWT.

get/v2/agents/{idOrAddress}/bot-instances/{botInstanceId}/diag

Request

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

Path parameters

idOrAddressstring required

Agent id, or the agent's 0x... address.

botInstanceIdstring required

BotInstance id (from the agent's bot-instances list).

Response

{
  ok: true,
  botInstance: {
    id: string, agentId: string, appId: string, xmppUsername: string,
    status: 'on'|'off', joinedRooms: string[], lastActiveAt: ISODate|null
  },
  aiService: object|null,     // live state reported by the AI service
  aiServiceError: string|null
}

Changes

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