agents
agents.test
conversations
events
custom_messages
prompts
session_labels
sessions.transcript
channels.targets
directory
dashboards
outbound.batches
Agent List
List the existing agents
Authorizations
Query Parameters
x > 0x > 0id, name, description, label, name_description, type, timezone, prompt_id, prompt_id_list, custom_message_id, languages, variables, prompt_tool_defaults, tool_headers, updated_at, last_updated_by id, name, description, label, name_description, type, timezone, prompt_id, prompt_id_list, custom_message_id, languages, variables, prompt_tool_defaults, tool_headers, updated_at, last_updated_by asc, desc id, name, description, label, name_description, type, timezone, prompt_id, prompt_id_list, custom_message_id, languages, variables, prompt_tool_defaults, tool_headers, updated_at, last_updated_by Response
ID of the custom message that should be delivered at the beginning of a conversation with the agent
The agent ID
Email of the user who last updated the agent
The agent name
ID of the prompt associated with the agent
The time zone in which the agent operates
Optional headers to include in tool calls for agent.
The agent type. Can be an arbitrary string
Timestamp of most recent update
Custom context variables for the conversation session. Keys should be prefixed with "vars.".
Channel targets associated with the agent
The ID of the agent associated with the channel target
The ID of the channel associated with the channel target
The name of the channel associated with the channel target
The ID of the channel target
Email of the user who last updated the channel target
The name of the channel target (must correspond to an organization-level target)
The mode of the channel target (must match one of the supported modes of the associated channel)
voice, chat, sms, email Timestamp of the most recent update to the channel target
Definition of the agent for the channel target
ID of the custom message that should be delivered at the beginning of a conversation with the agent
The agent ID
Email of the user who last updated the agent
The agent name
ID of the prompt associated with the agent
The time zone in which the agent operates
Optional headers to include in tool calls for agent.
The agent type. Can be an arbitrary string
Timestamp of most recent update
Custom context variables for the conversation session. Keys should be prefixed with "vars.".
Channel targets associated with the agent
The ID of the agent associated with the channel target
The ID of the channel associated with the channel target
The name of the channel associated with the channel target
The ID of the channel target
Email of the user who last updated the channel target
The name of the channel target (must correspond to an organization-level target)
The mode of the channel target (must match one of the supported modes of the associated channel)
voice, chat, sms, email Timestamp of the most recent update to the channel target
Definition of the agent for the channel target
The fallback for the channel target (currently only supported for "voice" mode)
Whether the channel target is intended for testing. If true, any sessions created through this target will be labeled as test.
The custom message associated with the agent. Will be delivered as a greeting at the beginning of a conversation.
The ID of the custom message
The email address of the user who most recently updated the custom message
The name of the custom message
The text of the custom message
Timestamp of the most recent update to the custom message
The number of agents using the custom message
The label of the custom message
Rules for time-specific message variants
The agent description
The agent label
BCP 47 codes of languages the agent supports
The prompt associated with the agent.
The prompt ID
The last updated date of the prompt
The configuration for the LLM that the prompt uses
The prompt name
The type of the prompt
The number of agents using the prompt
The prompt text
The description of the prompt
The comments for the most recent edit to the prompt
Email address of the user who most recently updated the prompt
Names of the tools to which the prompt has access
The fallback for the channel target (currently only supported for "voice" mode)
Whether the channel target is intended for testing. If true, any sessions created through this target will be labeled as test.
The custom message associated with the agent. Will be delivered as a greeting at the beginning of a conversation.
The ID of the custom message
The email address of the user who most recently updated the custom message
The name of the custom message
The text of the custom message
Timestamp of the most recent update to the custom message
The number of agents using the custom message
The label of the custom message
Rules for time-specific message variants
The description of the rule
Whether the rule logic should be inverted (i.e. "not")
Message text associated with the rule
The date for the rule in YYYY-MM-DD format
The days of the week for the rule
mo, tu, we, th, fr, sa, su The end of the time range for the rule in 24-hour format hh:mm (should be null for "all day" cases)
The start of the time range for the rule in 24-hour format hh:mm (should be null for "all day" cases)
The agent description
The agent label
BCP 47 codes of languages the agent supports
The prompt associated with the agent.
The prompt ID
The last updated date of the prompt
The configuration for the LLM that the prompt uses
Version of the API. (Currently only used for Azure OpenAI.)
Name of the model. Must match the deployment name in Azure AI Studio.
Provider of the LLM model.
azure_openai, openai Optional model version.
The prompt name
The type of the prompt
The number of agents using the prompt
The prompt text
The description of the prompt
The comments for the most recent edit to the prompt
Email address of the user who most recently updated the prompt
Names of the tools to which the prompt has access
The prompt tool defaults
The name of the tool