Agents

List AI Agents (v2)

Lists Agents visible to the caller, most recently updated first. Supports User JWT and B2B Server JWT. With a B2B Server JWT the caller (and so the owner of agents it creates) is the token's tenant App.

visibility selects the set:

  • omitted (default): the caller's own agents plus every public agent. unlisted agents of other owners are not listed.
  • public: public agents only.
  • mine: the caller's own agents, any visibility.
  • all / private: platform readers (isSuperAdmin.read) get every agent, or every private agent across all owners. For anyone else these values fall back to the default set.

Each item is an Agent object (see GET /v2/agents/{idOrAddress}) with originAppName, botInstancesCount and the live totalSiteSourceSize filled in.

get/v2/agents

Request

  • Base URL: https://api.chat.ethora.com
  • URL: https://api.chat.ethora.com/v2/agents
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Query parameters

visibility'public' | 'mine' | 'all' | 'private'
appIdstring

Only agents whose home App (ownerAppId) is this App.

category'customer-support' | 'persona' | 'entertainment' | 'worker'

Only agents tagged with this category. Spelling is normalised ("Customer support" and "customer_support" both mean customer-support).

limitinteger
offsetinteger

Response 

{
  ok: true,
  total: number,              // matching agents, ignoring limit/offset
  items: [Agent],
  results: [Agent],           // same as items
  pagination: { total: number }
}

Changes

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