PATCH
/
agents
/
{id}

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

ID of the agent to be updated.

Body

application/json
name
string

New name for the agent.

description
string

New description for the agent.

modelName
string

New LLM model to be used by the agent. Check the API for available model names.

temperature
number

New model temperature (min 0.0, max 1.0).

systemPrompt
string

New system prompt for the agent.

visibility
enum<string>

New visibility for the agent.

Available options:
public,
private
handle
string

New unique identifier (slug) for the agent.

interfaceConfig
object

New chat interface settings for this agent. Replaces the existing object.

enableInactiveHours
boolean | null

Enable or disable Inactive hours for the agent.

inactiveHours
object | null

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.

configUrlExternal
object

New external URL configurations. Replaces the existing object.

configUrlInfosSystemExternal
object

New external URL configurations of the system. Replaces the existing object.

tools
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 (only config is updatable for http, form, lead_capture types).
  • Existing tools in the agent that are not present in this array will be removed.

Response

200 - application/json
id
string
name
string
description
string | null
modelName
string

LLM - Model name.

temperature
number

Temperature of the model (min 0.0, max 1.0)

visibility
enum<string>
Available options:
public,
private
systemPrompt
string | null

Agent system prompt

enableInactiveHours
boolean | null

Enable or disable Inactive hours for the agent.

inactiveHours
object | null

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.

interfaceConfig
object

Chat interface settings for this agent.

tools
object[]

List of tools associated with the agent.

organizationId
string

ID of the organization the agent belongs to.

createdAt
string

Timestamp of when the agent was created.

updatedAt
string

Timestamp of the last update to the agent.

Was this page helpful?

Create AgentDelete Agent