GET
/
api
/
v1
/
agents
/
{agent_id}

Authorizations

​
Syllable-API-Key
string
headerrequired

Path Parameters

​
agent_id
integer
required

Response

200 - application/json
​
name
string
required

The Agent name

​
type
string
required

The Agent type

​
prompt_id
integer
required

The Agent's prompt id

​
timezone
string
required

The time zone the bot operates in

​
prompt_tool_defaults
object[]
required
​
languages
string[]
required
​
variables
object
required
​
tool_headers
object | null
required

Optional headers to include in tool calls.

​
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

​
custom_message_id
integer | null

The Agent's custom message id

​
channel_targets
object[] | null

Channel targets associated with the agent

​
prompt
object | null

The prompt associated with the agent

​
custom_message
object | null

The custom message associated with the agent

Create AgentDelete Agent