Update Agent

Changes state - verify before retry Updates a specific DRAFT version of an existing agent’s configuration. This is NOT a read-only action. version_number is required — published versions cannot be updated (only re-published). Only fields you provide are changed — omit anything you don’t want to touch. Use get_agent first to see current values and version numbers.

Parameters

Name	Type	Required	Description
`agent_id`	`string`	Yes	The agent ID, e.g. agent_abc123
`version_number`	`string`	Yes	The draft version number to update, e.g. 0 — from get_agent
`title`	`string`	No	Display name for the agent
`description`	`string`	No	Internal description of what the agent does
`agent_type`	`string`	No	Single_Prompt_Agent (default, one system prompt) or Conversational_Flow_Agent (CFA — a more freeform persona-driven agent built from agent_identity + agent_background instead of a single scripted prompt). If you’re building a CFA step by step with the user: first ask what the agent’s role/identity is (who it is, its purpose), then what background/context it should know, then any specific behavior rules — set agent_identity, agent_background, and prompt_text from those answers respectively. Both agent_identity and agent_background are REQUIRED (non-empty) when agent_type is Conversational_Flow_Agent — the call fails otherwise.
`agent_identity`	`string`	No	Required (non-empty) when agent_type is Conversational_Flow_Agent — who the agent is and its role/purpose. Not used by Single_Prompt_Agent.
`agent_background`	`string`	No	Required (non-empty) when agent_type is Conversational_Flow_Agent — background/context the agent should know. Not used by Single_Prompt_Agent.
`folder_id`	`string`	No	Folder ID to file this agent under, e.g. from list_organization_folders
`prompt_text`	`string`	No	The agent’s system/behavior prompt
`welcome_message`	`string`	No	First thing the agent says when a call connects
`language_id`	`string`	No	Language ID, e.g. lang_abc123 — from list_languages
`voice_id`	`string`	No	Voice ID, e.g. voice_abc123 — from list_voices
`llm_id`	`string`	No	LLM ID, e.g. llm_abc123 — from list_llms
`transcriber_id`	`string`	No	Transcriber ID, e.g. trs_abc123 — from list_transcribers
`extra_config`	`object (free-form)`	No	Any other CreateAgentDto/UpdateAgentDto field not listed above (voice_speed, kb_max_chunks, fallback settings, etc.). ID-shaped fields are normalized the same as the named fields above — pass them in their normal prefixed form as returned by other tools: knowledge_base_ids (kb_…, from list_knowledge_base_documents), inbound_phone_number_id/outbound_phone_number_id (phn_…), webhook_id (webhook_…), llm_fallback_model/fall_back_llm_id/post_call_analysis_llm_id (llm_…), stt_fallback_transcriber_id (trs_…), fallback_voices[].voice_id (voice_…). Everything else is passed through as-is. Use get_agent on a similar existing agent to see the full field shape first.

Before you call

Connect and initialize the MCP client with OAuth or an API key for the intended workspace.
Provide the required parameters: agent_id, version_number.

Example MCP request

Send tools/call after your client completes MCP initialization. Replace placeholder values with IDs and inputs from your workspace. For object and array parameters, follow the nested requirements in the parameter description instead of treating an empty value as complete.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "update_agent",
    "arguments": {
      "agent_id": "agent_abc123",
      "version_number": "1"
    }
  }
}

The server returns one text content block. Parse content[0].text as JSON when the tool succeeds. See MCP responses and errors for the full envelope and failure behavior.

Verify the result

Confirm the response is not marked isError. Call Get Agent to read the affected resource. Verify that the intended state is visible before making another change.

Retry safety

This tool changes workspace state. After a timeout, read the affected resource before retrying so you do not create duplicate or conflicting changes.

Get Agent: get_agent
List Knowledge Base Documents: list_knowledge_base_documents
List LLMs: list_llms
List Languages: list_languages
List Voices: list_voices
List Transcribers: list_transcribers
List Organization Folders: list_organization_folders
List Agents: list_agents
List Agent Versions: list_agent_versions

Start Here

Tool Reference

Parameters

Before you call

Example MCP request

Verify the result

Retry safety

​Parameters

​Before you call

​Example MCP request

​Verify the result

​Retry safety

​Related MCP tools

​Related guides

Parameters

Before you call

Example MCP request

Verify the result

Retry safety

Related MCP tools

Related guides