Skip to main content
​
string
Unique Id of the agent
​
string
This is the name you use to refer to the agent in your list of agents.
​
string
The description assists the AI in coordinating between user-facing agents by clarifying the purpose and functionality of each agent.
​
string
The prompt helps the AI understand what you want and how to respond. It guides the conversation and ensures relevant and coherent answers.
​
select
The type of agent. Options are:

user-facing : Agent directly interacts with users conversationally in a Q&A fashion. Only a single user-facing Agent engages with the user when a new query is input into the chatbot.

background : Agent never interacts with users directly and instead monitors the conversation in an ongoing fashion. All background Agents are run whenever the user submits a new query to the chatbot.

human-escalation : Agent routes the user’s query to a human. Only one human-escalation agent is allowed in each chatbot. It requires Chatsistant UI to fully use this feature.

pre-canned : Agent returns pre-canned response to user’s query

spam-defense : Agent enables the spam defending feature for the chatbot. Only one spam-defnese agent is allowed in each chatbot

​
boolean
Indicates whether the agent is enabled or disabled. If disabled, the agent will not be involved in the conversation.
​
string
Indicates agent modified time
​
string
Indicates agent creation time
​
List[string]
List of data sources UUIDs that the agent uses. If use_all_sources in agent’s meta is set to true, this field will be disabled.
Only for user-facing agents.
​
HumanEscalationSettings Object
Human escalation settings for the agent.
Only for human-escalation agents.
​
List[ToolFunction]
List of tool functions that the agent uses.
Only for user-facing and background agents.
​
List[AgentVariable]
List of variables that the agent uses.
Only for user-facing agents.
​
meta Object
Agent meta properties