uuid
string

Unique Id of the agent

name
string

This is the name you use to refer to the agent in your list of agents.

description
string

The description assists the AI in coordinating between user-facing agents by clarifying the purpose and functionality of each agent.

prompt
string

The prompt helps the AI understand what you want and how to respond. It guides the conversation and ensures relevant and coherent answers.

type
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 GPT-trainer 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

enabled
boolean

Indicates whether the agent is enabled or disabled. If disabled, the agent will not be involved in the conversation.

modified_at
string

Indicates agent modified time

created_at
string

Indicates agent creation time

data_source_uuids
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.

human_escalation_settings
HumanEscalationSettings Object

Human escalation settings for the agent.
Only for human-escalation agents.

tool_functions
List[ToolFunction]

List of tool functions that the agent uses.
Only for user-facing and background agents.

variables
List[AgentVariable]

List of variables that the agent uses.
Only for user-facing agents.

meta
meta Object

Agent meta properties