Skip to main content
PUT
/
agents
/
{agent_id}
Update Agent
curl --request PUT \
  --url https://api.example.com/agents/{agent_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "default_user_lang": "<string>",
  "thinking_lang": "<string>",
  "default_voice_id": "<string>",
  "interruptions_enabled": true,
  "escalation_policy": {},
  "model_provider": "<string>",
  "model_name": "<string>",
  "temperature": 0.5,
  "max_tokens": 525,
  "system_prompt": "<string>",
  "persona": "<string>",
  "first_message_mode": "<string>",
  "first_message_script": "<string>",
  "voice_provider": "<string>",
  "voice_id": "<string>",
  "background_sound_url": "<string>",
  "input_min_characters": 55,
  "transcriber_provider": "<string>",
  "transcriber_model": "<string>",
  "background_denoising": true,
  "confidence_threshold": 0.5,
  "multilingual_enabled": true,
  "supported_languages": [
    "<string>"
  ],
  "language_detection_provider": "<string>",
  "respond_in_user_language": true,
  "wait_seconds": 0.55,
  "smart_endpointing": true,
  "interruption_words": 5,
  "punctuation_boundary_ms": 275,
  "no_punctuation_boundary_ms": 1900,
  "silence_timeout_seconds": 65,
  "max_duration_seconds": 990,
  "idle_messages_enabled": true,
  "max_idle_messages": 5,
  "idle_timeout_seconds": 32.5,
  "analysis_prompt": "<string>",
  "analysis_timeout_sec": 30,
  "min_messages_for_analysis": 5,
  "voicemail_detection_enabled": true,
  "voicemail_message": "<string>",
  "end_call_message": "<string>",
  "keypad_input_enabled": true,
  "keypad_timeout_seconds": 3,
  "keypad_delimiters": "<string>",
  "sip_enabled": true,
  "recording_enabled": true,
  "analytics_enabled": true
}
'
{
  "created_at": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "default_user_lang": "<string>",
  "thinking_lang": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "owner_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "updated_at": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "default_voice_id": "<string>",
  "interruptions_enabled": true,
  "escalation_policy": {},
  "model_provider": "openai",
  "model_name": "gpt-4o-mini",
  "temperature": 0.7,
  "max_tokens": 150,
  "system_prompt": "<string>",
  "persona": "<string>",
  "first_message_mode": "assistant-speaks-first",
  "first_message_script": "<string>",
  "voice_provider": "elevenlabs",
  "voice_id": "<string>",
  "background_sound_url": "<string>",
  "input_min_characters": 30,
  "transcriber_provider": "deepgram",
  "transcriber_model": "nova-3",
  "background_denoising": true,
  "confidence_threshold": 0.4,
  "multilingual_enabled": false,
  "supported_languages": [
    "<string>"
  ],
  "language_detection_provider": "auto",
  "respond_in_user_language": true,
  "wait_seconds": 0.4,
  "smart_endpointing": true,
  "interruption_words": 3,
  "punctuation_boundary_ms": 100,
  "no_punctuation_boundary_ms": 1500,
  "silence_timeout_seconds": 30,
  "max_duration_seconds": 600,
  "idle_messages_enabled": true,
  "max_idle_messages": 3,
  "idle_timeout_seconds": 7.5,
  "analysis_prompt": "<string>",
  "analysis_timeout_sec": 10,
  "min_messages_for_analysis": 2,
  "voicemail_detection_enabled": true,
  "voicemail_message": "<string>",
  "end_call_message": "<string>",
  "keypad_input_enabled": false,
  "keypad_timeout_seconds": 2,
  "keypad_delimiters": "#",
  "sip_enabled": false,
  "recording_enabled": true,
  "analytics_enabled": true,
  "meta_data": {},
  "workflow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Documentation Index

Fetch the complete documentation index at: https://docs.mrassistant.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
agent_id
string<uuid>
required

Body

application/json

Agent update model - all fields optional for partial updates.

​
name
string | null
Required string length: 1 - 255
​
description
string | null
​
default_user_lang
string | null
Required string length: 2 - 10
​
thinking_lang
string | null
Required string length: 2 - 10
​
default_voice_id
string | null
​
interruptions_enabled
boolean | null
​
escalation_policy
Escalation Policy · object
​
status
enum<string> | null

Agent status enumeration.

Available options:
draft,
active,
paused
​
model_provider
string | null
Pattern: ^(openai|azure_openai|anthropic|google|groq|cerebras|deepseek|xai|perplexity|together|amazon_bedrock|anyscale|openrouter|deepinfra)$
​
model_name
string | null
Required string length: 1 - 100
​
temperature
number | null
Required range: 0 <= x <= 1
​
max_tokens
integer | null
Required range: 50 <= x <= 1000
​
system_prompt
string | null

System prompt defining role/behavior. Send empty string to clear.

Maximum string length: 8000
​
persona
string | null

Short character/personality. Send empty string to clear.

Maximum string length: 2000
​
first_message_mode
string | null
Pattern: ^(assistant-speaks-first|wait-for-user|assistant-speaks-first-with-model-generated-message)$
​
first_message_script
string | null
Maximum string length: 500
​
voice_provider
string | null
Pattern: ^(elevenlabs|cartesia|openai|deepgram|google|azure|rime|lmnt)$
​
voice_id
string | null
​
background_sound_url
string | null
Maximum string length: 500
​
input_min_characters
integer | null
Required range: 10 <= x <= 100
​
transcriber_provider
string | null
Pattern: ^(deepgram|openai|assemblyai|google|azure)$
​
transcriber_model
string | null
Required string length: 1 - 100
​
background_denoising
boolean | null
​
confidence_threshold
number | null
Required range: 0 <= x <= 1
​
multilingual_enabled
boolean | null
​
supported_languages
string[] | null
​
language_detection_provider
string | null
Pattern: ^(auto|deepgram|whisper)$
​
respond_in_user_language
boolean | null
​
wait_seconds
number | null
Required range: 0.1 <= x <= 1
​
smart_endpointing
boolean | null
​
interruption_words
integer | null
Required range: 0 <= x <= 10
​
punctuation_boundary_ms
integer | null
Required range: 50 <= x <= 500
​
no_punctuation_boundary_ms
integer | null
Required range: 800 <= x <= 3000
​
silence_timeout_seconds
integer | null
Required range: 10 <= x <= 120
​
max_duration_seconds
integer | null
Required range: 180 <= x <= 1800
​
idle_messages_enabled
boolean | null
​
max_idle_messages
integer | null
Required range: 1 <= x <= 10
​
idle_timeout_seconds
number | null
Required range: 5 <= x <= 60
​
analysis_prompt
string | null
Maximum string length: 2000
​
analysis_timeout_sec
integer | null
Required range: 1 <= x <= 60
​
min_messages_for_analysis
integer | null
Required range: 0 <= x <= 10
​
voicemail_detection_enabled
boolean | null
​
voicemail_message
string | null
Maximum string length: 500
​
end_call_message
string | null
Maximum string length: 500
​
keypad_input_enabled
boolean | null
​
keypad_timeout_seconds
integer | null
Required range: 1 <= x <= 6
​
keypad_delimiters
string | null
Pattern: ^[#*]+$
​
sip_enabled
boolean | null

Enable SIP/phone calling for this agent

​
recording_enabled
boolean | null

Enable call recording for this agent

​
analytics_enabled
boolean | null

Enable analytics tracking for this agent

Response

Successful Response

Agent response model.

​
created_at
string<date-time>
required
​
name
string
required
Required string length: 1 - 255
​
default_user_lang
string
required
Required string length: 2 - 10
​
thinking_lang
string
required
Required string length: 2 - 10
​
id
string<uuid>
required
​
owner_id
string<uuid>
required
​
status
enum<string>
required

Agent status enumeration.

Available options:
draft,
active,
paused
​
updated_at
string<date-time> | null
​
description
string | null
​
default_voice_id
string | null
​
interruptions_enabled
boolean
default:true
​
escalation_policy
Escalation Policy · object
​
model_provider
string
default:openai
Pattern: ^(openai|azure_openai|anthropic|google|groq|cerebras|deepseek|xai|perplexity|together|amazon_bedrock|anyscale|openrouter|deepinfra)$
​
model_name
string
default:gpt-4o-mini
Required string length: 1 - 100
​
temperature
number
default:0.7
Required range: 0 <= x <= 1
​
max_tokens
integer
default:150
Required range: 50 <= x <= 1000
​
system_prompt
string | null

Full system prompt defining the agent's role, behavior, and instructions. Falls back to description if not set.

Maximum string length: 8000
​
persona
string | null

Short character/personality descriptor (e.g. 'Friendly British accountant'). Renders as 'Personality: ...' in the system prompt.

Maximum string length: 2000
​
first_message_mode
string
default:assistant-speaks-first
Pattern: ^(assistant-speaks-first|wait-for-user|assistant-speaks-first-with-model-generated-message)$
​
first_message_script
string | null
Maximum string length: 500
​
voice_provider
string
default:elevenlabs
Pattern: ^(elevenlabs|cartesia|openai|deepgram|google|azure|rime|lmnt)$
​
voice_id
string | null
​
background_sound_url
string | null
Maximum string length: 500
​
input_min_characters
integer
default:30
Required range: 10 <= x <= 100
​
transcriber_provider
string
default:deepgram
Pattern: ^(deepgram|openai|assemblyai|google|azure)$
​
transcriber_model
string
default:nova-3
Required string length: 1 - 100
​
background_denoising
boolean
default:true
​
confidence_threshold
number
default:0.4
Required range: 0 <= x <= 1
​
multilingual_enabled
boolean
default:false

Enable automatic language detection for multilingual conversations

​
supported_languages
string[] | null

List of language codes the agent supports (e.g., ['en', 'es', 'fr']). If multilingual_enabled=true and this is empty, all languages are supported.

​
language_detection_provider
string
default:auto

Provider for language detection: 'auto' uses STT provider's built-in detection

Pattern: ^(auto|deepgram|whisper)$
​
respond_in_user_language
boolean
default:true

When true, agent responds in the detected user language. When false, always responds in default_user_lang.

​
wait_seconds
number
default:0.4
Required range: 0.1 <= x <= 1
​
smart_endpointing
boolean
default:true
​
interruption_words
integer
default:3
Required range: 0 <= x <= 10
​
punctuation_boundary_ms
integer
default:100
Required range: 50 <= x <= 500
​
no_punctuation_boundary_ms
integer
default:1500
Required range: 800 <= x <= 3000
​
silence_timeout_seconds
integer
default:30
Required range: 10 <= x <= 120
​
max_duration_seconds
integer
default:600
Required range: 180 <= x <= 1800
​
idle_messages_enabled
boolean
default:true
​
max_idle_messages
integer
default:3
Required range: 1 <= x <= 10
​
idle_timeout_seconds
number
default:7.5
Required range: 5 <= x <= 60
​
analysis_prompt
string | null
Maximum string length: 2000
​
analysis_timeout_sec
integer
default:10
Required range: 1 <= x <= 60
​
min_messages_for_analysis
integer
default:2
Required range: 0 <= x <= 10
​
voicemail_detection_enabled
boolean
default:true
​
voicemail_message
string | null
Maximum string length: 500
​
end_call_message
string | null
Maximum string length: 500
​
keypad_input_enabled
boolean
default:false
​
keypad_timeout_seconds
integer
default:2
Required range: 1 <= x <= 6
​
keypad_delimiters
string
default:#
Pattern: ^[#*]+$
​
sip_enabled
boolean
default:false

Enable SIP/phone calling for this agent

​
recording_enabled
boolean
default:true

Enable call recording for this agent

​
analytics_enabled
boolean
default:true

Enable analytics tracking for this agent

​
meta_data
Meta Data · object
​
workflow_id
string<uuid> | null