Skip to main content

Interface: Agent

Defined in: type/Agent.ts:7

Object class for Agent

Properties​

active​

active: boolean

Defined in: type/Agent.ts:19

Whether the agent is currently active and available for interactions.

buttonLabels?​

optional buttonLabels?: LocalizedString[]

Defined in: type/Agent.ts:17

Localized button labels for the agent.

createdAt​

createdAt: string

Defined in: type/Agent.ts:31

Timestamp when the agent was created.

createdByAdminUserId?​

optional createdByAdminUserId?: number

Defined in: type/Agent.ts:35

Admin user ID who created the agent.

descriptions?​

optional descriptions?: LocalizedString[]

Defined in: type/Agent.ts:13

Localized descriptions for the agent.

id​

id: string

Defined in: type/Agent.ts:9

Unique identifier for the agent.

interactionMode​

interactionMode: AgentInteractionMode

Defined in: type/Agent.ts:25

Interaction mode defining the conversational pattern.

lastModifiedAt​

lastModifiedAt: string

Defined in: type/Agent.ts:33

Timestamp when the agent was last modified.

lastModifiedByAdminUserId?​

optional lastModifiedByAdminUserId?: number

Defined in: type/Agent.ts:37

Admin user ID who last modified the agent.

names​

names: LocalizedString[]

Defined in: type/Agent.ts:11

Localized display names for the agent.

trigger​

trigger: AgentTrigger

Defined in: type/Agent.ts:23

Trigger mechanism that activates the agent interaction.

types​

types: string[]

Defined in: type/Agent.ts:21

Classification types for the agent in SCREAMING_SNAKE_CASE format.

webhookTimeoutMs​

webhookTimeoutMs: number

Defined in: type/Agent.ts:29

Timeout in milliseconds for webhook requests.

webhookUrl​

webhookUrl: string

Defined in: type/Agent.ts:27

URL of the external webhook that processes agent requests.

welcomeMessages?​

optional welcomeMessages?: LocalizedString[]

Defined in: type/Agent.ts:15

Localized welcome messages displayed when the agent is activated.