Skip to main content
Update A Registered Agent

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required

Body

application/json

Schema for updating an existing agent.

name
string | null

Name of the agent

description
string | null

Updated description

instructions
string | null

Updated instructions

tools
string[] | null

Updated list of tool names

collaborators
string[] | null

Updated list of collaborator names

llm
string | null

Updated LLM identifier

style
enum<string> | null

Style of the agent

Available options:
default,
react,
planner,
custom,
react_intrinsic,
experimental_customer_care,
code_act
supported_apps
enum<string>[] | null

Supported apps of the agent

Available options:
slack/askhr
glossary
string[] | null

List of glossary available to the agent

guidelines
Guideline · object[] | null

List of guidelines for the agent behavior

knowledge_base
string[] | null

List of knowledge_base available to the agent

hidden
boolean

To show or hide agent when agents are listed

display_name
string | null

Display name of the agent

structured_output
Structured Output · object | null

JSON schema defining the structure for agent responses

custom_join_tool
string | null

Reference to a Python tool that will be used for custom synthesis of task results

additional_properties
AgentAdditionalPropertiesIn · object | null

Agent Additional Settings

tags
string[] | null

List of tags associated to agent

voice_configuration_id
string<uuid> | null

Voice configuration for the agent

chat_with_docs
ChatWithDocsConfig · object | null

Chat with Documents config for Agent

context_access_enabled
boolean | null

Enable access to context variables for this agent

connection_ids
string[] | null

List of connection IDs for direct agent-to-connection bindings

context_variables
string[] | null

List of context variable names that this agent can access

hide_reasoning
boolean | null

Enable/disable reasoning trace

workspace_id
string<uuid> | null

ID of the workspace that owns this agent

llm_config
ModelConfig · object | null
plugins
Plugins · object | null

Plugins and hook points associated to the agents

sync_tool_flow_interactions
boolean | null

Enable/disable syncing user interactions from tool flow to the agent

toolkits
string[] | null

Updated list of toolkit ids

memory_enabled
boolean | null

Enable/disable agentic memory for this agent

timeout_seconds
integer | null

Timeout in seconds for agent execution (min=120, max=900)

custom_agents_metadata
Custom Agents Metadata · object | null

Metadata for custom agents (language, framework, tool count, tool names, connection requirements)

Response

Successful Response