Update Agent
Partially updates an existing agent based on the ID. Allows updating one or more fields of a specific agent. Only the fields provided in the request body will be updated.
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
ID of the agent to be updated.
Body
New name for the agent.
New description for the agent.
New LLM model to be used by the agent. Check the API for available model names.
New model temperature (min 0.0, max 1.0).
New system prompt for the agent.
New visibility for the agent.
public
, private
New unique identifier (slug) for the agent.
New chat interface settings for this agent. Replaces the existing object.
Enable or disable Inactive hours for the agent.
A JSON object specifying the agent's inactive hours per channel. The top-level keys represent the channel (e.g., whatsapp
, website
,instagram
), and each key contains an object with the days of the week and their respective inactive time ranges.
New external URL configurations. Replaces the existing object.
New external URL configurations of the system. Replaces the existing object.
List of tools for the agent. This array defines the final state of the tools.
- Tools in the array without an
id
will be created. - Tools in the array with an existing
id
will be updated (onlyconfig
is updatable forhttp
,form
,lead_capture
types). - Existing tools in the agent that are not present in this array will be removed.
Response
LLM - Model name.
Temperature of the model (min 0.0, max 1.0)
public
, private
Agent system prompt
Enable or disable Inactive hours for the agent.
A JSON object specifying the agent's inactive hours per channel. The top-level keys represent the channel (e.g., whatsapp
, website
,instagram
), and each key contains an object with the days of the week and their respective inactive time ranges.
Chat interface settings for this agent.
List of tools associated with the agent.
ID of the organization the agent belongs to.
Timestamp of when the agent was created.
Timestamp of the last update to the agent.
Was this page helpful?