Agent Properties

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 Chatbot 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

Show properties

model

select

Model	Message Credits
gpt-3.5-turbo	1
gpt-3.5-turbo-16k	8
gpt-4-0125-preview-8k	35
gpt-4-1106-preview-1k	5
gpt-4-1106-preview-2k	10
gpt-4-1106-preview-4k	20
gpt-4-1106-preview-16k	60
gpt-4o-1k	3
gpt-4o-2k	5
gpt-4o-4k	10
gpt-4o-8k	20
gpt-4o-16k	40
gpt-4o-mini-4k	1
gpt-4o-mini-16k	8
Only for `user-facing` and `background` agents.

temperature

float

A higher temperature value, such as 1, allows for more randomness and creativity in the responses. This can lead to more diverse and unexpected answers. On the other hand, a lower temperature value, closer to 0, produces more focused and deterministic responses, making them more conservative and predictable. Options are values as a float between 0 and 1
Only for user-facing agents.

bias

float

How AI supervisor should be biased towards the agent. A higher value will make the AI supervisor more biased towards the agent. Options are values as a float between 0 and 1.
Only for user-facing, human-escalation, pre-canned and spam-defense agents.

stickness

float

How sticky the AI supervisor should be stick with the agent when the lastest user’s query is handled by this agent. Options are values as a float between 0 and 1.
Only for user-facing, human-escalation, pre-canned and spam-defense agents.

default_message

string

Default message to show when the agent is triggered.
Only for pre-canned and spam-defense agents.

API Usage Guides

Chatbots

Agents

Chatbot Sessions

Session Messages

Data Sources

Data Source Tags