Skip to main content
PUT
/
v1
/
agents
/
{agent_id}
Update Agent
curl --request PUT \
  --url https://api.example.com/v1/agents/{agent_id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "config": {
    "pipeline_mode": "cascade",
    "system_prompt": "",
    "first_message": "<string>",
    "stt": {
      "provider": "deepgram",
      "model": "nova-3",
      "language": "en",
      "extra": {}
    },
    "llm": {
      "provider": "openai",
      "model": "gpt-4o-mini",
      "temperature": 0.7,
      "max_tokens": 1024,
      "base_url": "<string>",
      "api_key": "<string>",
      "extra": {}
    },
    "tts": {
      "provider": "deepgram",
      "model": "aura-2-helena-en",
      "voice": "aura-2-helena-en",
      "speed": 1,
      "extra": {}
    },
    "language": "en",
    "tools": [
      {
        "name": "<string>",
        "description": "<string>",
        "parameters_schema": {},
        "execution_mode": "sync",
        "webhook_url": "<string>",
        "timeout_seconds": 10,
        "max_retries": 1
      }
    ],
    "mcp_servers": [
      {
        "name": "<string>",
        "transport": "http",
        "url": "<string>",
        "headers": {},
        "command": "<string>",
        "args": [
          "<string>"
        ],
        "env": {},
        "timeout_seconds": 10,
        "tool_filter": [
          "<string>"
        ]
      }
    ],
    "guardrails": {
      "max_tool_calls_per_turn": 5,
      "prohibited_topics": [
        "<string>"
      ],
      "extra": {}
    },
    "analysis": {
      "enabled": true,
      "summary_enabled": true,
      "summary_prompt": "<string>",
      "success_evaluation": {
        "enabled": false,
        "rubric": "",
        "scale": "pass_fail"
      },
      "sentiment_enabled": false,
      "structured_extraction_schema": {},
      "scoring_rubric": {},
      "model": "<string>",
      "extra": {}
    },
    "silence_timeout_ms": 800,
    "interruption_enabled": true,
    "smart_turn_detection": true,
    "smart_turn_stop_secs": 3,
    "max_call_duration_seconds": 3600,
    "voicemail_detection": {
      "enabled": false,
      "voicemail_message": "<string>",
      "backoff_plan": {
        "max_retries": 3,
        "start_at_seconds": 5,
        "frequency_seconds": 3
      },
      "beep_max_await_seconds": 5,
      "voicemail_expected_duration_seconds": 15,
      "custom_system_prompt": "<string>"
    },
    "s2s": {
      "provider": "openai",
      "model": "gpt-4o-realtime-preview",
      "voice": "alloy",
      "turn_detection": "server_vad",
      "extra": {}
    },
    "transport": "twilio",
    "server_url": {
      "url": "<string>",
      "secret": "<string>",
      "timeout_seconds": 5,
      "events": [
        "<string>"
      ]
    },
    "metadata": {}
  }
}
'
{}

Headers

authorization
string | null

Path Parameters

agent_id
string<uuid>
required

Body

application/json
name
string | null
Required string length: 1 - 255
config
AgentConfigSchema · object

Response

Successful Response

The response is of type Response Update Agent V1 Agents Agent Id Put · object.