@egain/ai-agent-sdk API Reference - v0.3.2 / GetAgentsByPortalOptions

Interface: GetAgentsByPortalOptions

Options for getAgentsByPortal API call. Fetches AI agents available in a portal.

Table of contents

Properties

• departmentId
• portalId
• agentType
• authToken

Properties

departmentId

• departmentId: string | number

Department ID (from portal.department.id)

Defined in

core/api/ApiHelper.ts:225

---

portalId

• portalId: string | number

Portal ID

Defined in

core/api/ApiHelper.ts:230

---

agentType

• Optional agentType: string

Agent type filter

Default

"contact-center"

Defined in

core/api/ApiHelper.ts:236

---

authToken

• Optional authToken: string

Authentication token (required if ApiHelper was constructed without getToken)

Defined in

core/api/ApiHelper.ts:241