Sign in

v1

latestOpenAPI 3.1.02026-07-26252382475.4 KB
Agents

Update A Registered Agent

Updates an existing agent by id.

patch/v1/orchestrate/agents/{id}

Path parameters

idstring required

Request body

namestring nullable

Name of the agent

descriptionstring nullable

Updated description

instructionsstring nullable

Updated instructions

toolsstring[] nullable

Updated list of tool names

collaboratorsstring[] nullable

Updated list of collaborator names

llmstring nullable

Updated LLM identifier

style'default' | 'react' | 'planner' | 'custom' | 'react_intrinsic' | 'experimental_customer_care' | 'code_act'
supported_appsSupportedApp[] nullable

Supported apps of the agent

glossarystring[] nullable

List of glossary available to the agent

knowledge_basestring[] nullable

List of knowledge_base available to the agent

hiddenboolean

To show or hide agent when agents are listed

display_namestring nullable

Display name of the agent

structured_outputobject nullable

JSON schema defining the structure for agent responses

custom_join_toolstring nullable

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

tagsstring[] nullable

List of tags associated to agent

voice_configuration_idstring uuid nullable

Voice configuration for the agent

context_access_enabledboolean nullable

Enable access to context variables for this agent

connection_idsstring[] nullable

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

context_variablesstring[] nullable

List of context variable names that this agent can access

hide_reasoningboolean nullable

Enable/disable reasoning trace

workspace_idstring uuid nullable

ID of the workspace that owns this agent

sync_tool_flow_interactionsboolean nullable

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

toolkitsstring[] nullable

Updated list of toolkit ids

memory_enabledboolean nullable

Enable/disable agentic memory for this agent

timeout_secondsinteger nullable

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

custom_agents_metadataobject nullable

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

Response

Successful Response

{"stackTrail":"paths:/v1/orchestrate/agents/{id}:patch:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}