PUT
/
api
/
v1
/
agents

Authorizations

Syllable-API-Key
string
header
required

Body

application/json
name
string
required

The agent name

type
string
required

The agent type. Can be an arbitrary string

prompt_id
integer
required

ID of the prompt associated with the agent

custom_message_id
integer
required

ID of the custom message that should be delivered at the beginning of a conversation with the agent

timezone
string
required

The time zone in which the agent operates

variables
object
required

Custom context variables for the conversation session. Keys should be prefixed with "vars.".

tool_headers
object | null
required

Optional headers to include in tool calls for agent.

id
integer
required

The agent ID

description
string | null

The agent description

label
string | null

The agent label

prompt_tool_defaults
object[]

User-configured parameter values for the agent's tools

languages
string[]

BCP 47 codes of languages the agent supports

agent_initiated
boolean
default:
false

Whether the agent initiates conversation with a user after the custom_message is delivered

Response

200
application/json

When a user interacts with the Syllable system, they do so by communicating with an agent. An agent is linked to a prompt, a custom message, and one or more channel targets to define its behavior and capabilities.

name
string
required

The agent name

type
string
required

The agent type. Can be an arbitrary string

prompt_id
integer
required

ID of the prompt associated with the agent

custom_message_id
integer
required

ID of the custom message that should be delivered at the beginning of a conversation with the agent

timezone
string
required

The time zone in which the agent operates

variables
object
required

Custom context variables for the conversation session. Keys should be prefixed with "vars.".

tool_headers
object | null
required

Optional headers to include in tool calls for agent.

id
integer
required

The agent ID

updated_at
string
required

Timestamp of most recent update

last_updated_by
string | null
required

Email of the user who last updated the agent

description
string | null

The agent description

label
string | null

The agent label

prompt_tool_defaults
object[]

User-configured parameter values for the agent's tools

languages
string[]

BCP 47 codes of languages the agent supports

agent_initiated
boolean
default:
false

Whether the agent initiates conversation with a user after the custom_message is delivered

prompt
object | null

The prompt associated with the agent.

custom_message
object | null

The custom message associated with the agent. Will be delivered as a greeting at the beginning of a conversation.

channel_targets
object[] | null

Channel targets associated with the agent

tools
object[] | null

Tools associated with the agent