Update AI Agent

PUT

ai-agents

{agent_id}

{
  "ai_agent_id": "<string>",
  "agent_name": "<string>",
  "language_code": "en-US",
  "llm": {
    "llm_id": "<string>",
    "llm_type": "<string>",
    "model_provider": "openai",
    "model_name": "<string>",
    "model_temperature": 0,
    "llm_name": "<string>",
    "llm_description": "<string>",
    "base_url": "<string>",
    "api_key": "<string>",
    "max_tokens": 123,
    "required_dynamic_data": [
      "<string>"
    ],
    "system_prompt": "<string>",
    "tools": [
      {}
    ]
  },
  "stt": {
    "provider": "<string>",
    "model": "nova-2-general"
  },
  "tts": {
    "provider": "<string>",
    "voice_id": "<string>",
    "voice_name": "<string>",
    "model_name": "eleven_turbo_v2_5",
    "voice_temperature": 0.5
  },
  "knowledge_base_id": "<string>",
  "enable_user_interruptions": true,
  "minimum_speech_duration_for_interruptions": 0.5,
  "minimum_words_before_interruption": 0,
  "wait_time_before_detecting_end_of_speech": 0.5,
  "ambient_sound": "none",
  "ambient_sound_volume": 1,
  "webhook_url": "<string>",
  "end_call_after_silence_seconds": 10,
  "max_call_duration_seconds": 1800,
  "welcome_message": "<string>",
  "voicemail_detection_timeout_seconds": 90,
  "dynamic_data_config": [
    {
      "url": "<string>",
      "method": "<string>",
      "timeout": 123,
      "headers": {},
      "body": {},
      "query": {},
      "cache": true,
      "response_data": [
        {
          "name": "<string>",
          "data": "<string>",
          "context": "<string>"
        }
      ]
    }
  ],
  "post_call_analysis": [
    {
      "type": "<string>",
      "name": "<string>",
      "description": "<string>",
      "system_prompt": "<string>",
      "examples": [
        "<string>"
      ]
    }
  ],
  "created_by_user_id": "<string>"
}

Path Parameters

agent_id

string

required

Body

application/json

agent_name

string | null

The display name for the AI agent that will be used in logs, analytics and user interfaces

language_code

string | null

BCP-47 language code (e.g., 'en-US', 'es-ES') that specifies the primary language for the agent's speech and understanding

llm

object | null

Updated configuration for the Language Learning Model (LLM) that powers the agent's conversational abilities

stt

object | null

Updated configuration for the Speech-to-Text service that converts user speech to text for processing

tts

object | null

Updated configuration for the Text-to-Speech service that converts the agent's responses to natural speech

knowledge_base_id

string | null

ID reference to a knowledge base containing domain-specific information the agent can use to enhance responses

minimum_speech_duration_for_interruptions

number | null

Minimum duration in seconds that a user must speak before the agent can be interrupted, helps prevent premature interruptions

Required range: 0 <= x <= 15

minimum_words_before_interruption

integer | null

Minimum number of words that must be spoken before allowing interruption, provides more natural conversation flow

Required range: 0 <= x <= 5

wait_time_before_detecting_end_of_speech

number | null

Time in seconds to wait for additional speech before concluding the user has finished speaking

Required range: 0 <= x <= 15

ambient_sound

enum<string> | null

Type of background ambient sound to play during calls to create a more immersive and natural environment

Available options:

office,

cafe,

restaurant,

park,

street,

home,

library,

airport,

train_station,

beach,

none

ambient_sound_volume

number | null

Volume level for the ambient background sound, ranging from 0 (muted) to 2 (maximum volume)

Required range: 0 <= x <= 2

webhook_url

string | null

HTTPS URL endpoint where real-time call events and updates will be sent via webhook notifications

end_call_after_silence_seconds

number | null

Number of seconds of continuous silence after which the call will automatically end to prevent hanging calls

Required range: 10 <= x <= 30

max_call_duration_seconds

number | null

Maximum allowed duration for a single call in seconds (between 30 seconds and 1 hour) to prevent indefinite calls

Required range: 30 <= x <= 3600

welcome_message

string | null

Custom greeting message that the agent will speak at the beginning of each call

voicemail_detection_timeout_seconds

number | null

Maximum time in seconds to wait while attempting to detect if the call was answered by a voicemail system

Required range: x >= 0

dynamic_data_config

object[] | null

Configuration for external data sources that the agent can query in real-time during calls to provide up-to-date information

post_call_analysis

object[] | null

Configuration for automated analysis tasks to be performed after each call, such as sentiment analysis or call summarization

Response

200

application/json

Successful Response

ai_agent_id

string

required

Unique identifier for the AI agent

agent_name

string

required

Name of the AI agent

llm

object

required

Language model configuration for the AI agent

stt

object

required

Speech-to-text configuration for the AI agent

tts

object

required

Text-to-speech configuration for the AI agent

created_by_user_id

string

required

ID of the user who created this AI agent

language_code

string

default:en-US

Language code for the AI agent in BCP-47 format

knowledge_base_id

string | null

ID of the associated knowledge base, if any

enable_user_interruptions

boolean

default:true

Whether to allow users to interrupt the AI agent while speaking

minimum_speech_duration_for_interruptions

number

default:0.5

Minimum duration of speech in seconds before interruptions are allowed

Required range: 0 <= x <= 15

minimum_words_before_interruption

integer

default:0

Minimum number of words that must be spoken before interruption is allowed

Required range: 0 <= x <= 5

wait_time_before_detecting_end_of_speech

number

default:0.5

Time in seconds to wait before considering speech has ended

Required range: 0 <= x <= 15

ambient_sound

enum<string>

default:none

Type of ambient background sound to use during calls

Available options:

office,

cafe,

restaurant,

park,

street,

home,

library,

airport,

train_station,

beach,

none

ambient_sound_volume

number

default:1

Volume level for ambient sound, from 0 (muted) to 2 (loud)

Required range: 0 <= x <= 2

webhook_url

string | null

URL to send webhook notifications about call events

end_call_after_silence_seconds

number

default:10

Number of seconds of silence before automatically ending the call

Required range: 10 <= x <= 30

max_call_duration_seconds

number

default:1800

Maximum duration of a call in seconds

Required range: 30 <= x <= 3600

welcome_message

string | null

Custom welcome message to play at the start of calls

voicemail_detection_timeout_seconds

number

default:90

Time in seconds to wait for voicemail detection

Required range: x >= 0

dynamic_data_config

object[] | null

Configuration for dynamic data sources that can be used during calls

post_call_analysis

object[] | null

Configuration for analysis items to be processed after calls

Get AI Agent Delete AI Agent

{
  "ai_agent_id": "<string>",
  "agent_name": "<string>",
  "language_code": "en-US",
  "llm": {
    "llm_id": "<string>",
    "llm_type": "<string>",
    "model_provider": "openai",
    "model_name": "<string>",
    "model_temperature": 0,
    "llm_name": "<string>",
    "llm_description": "<string>",
    "base_url": "<string>",
    "api_key": "<string>",
    "max_tokens": 123,
    "required_dynamic_data": [
      "<string>"
    ],
    "system_prompt": "<string>",
    "tools": [
      {}
    ]
  },
  "stt": {
    "provider": "<string>",
    "model": "nova-2-general"
  },
  "tts": {
    "provider": "<string>",
    "voice_id": "<string>",
    "voice_name": "<string>",
    "model_name": "eleven_turbo_v2_5",
    "voice_temperature": 0.5
  },
  "knowledge_base_id": "<string>",
  "enable_user_interruptions": true,
  "minimum_speech_duration_for_interruptions": 0.5,
  "minimum_words_before_interruption": 0,
  "wait_time_before_detecting_end_of_speech": 0.5,
  "ambient_sound": "none",
  "ambient_sound_volume": 1,
  "webhook_url": "<string>",
  "end_call_after_silence_seconds": 10,
  "max_call_duration_seconds": 1800,
  "welcome_message": "<string>",
  "voicemail_detection_timeout_seconds": 90,
  "dynamic_data_config": [
    {
      "url": "<string>",
      "method": "<string>",
      "timeout": 123,
      "headers": {},
      "body": {},
      "query": {},
      "cache": true,
      "response_data": [
        {
          "name": "<string>",
          "data": "<string>",
          "context": "<string>"
        }
      ]
    }
  ],
  "post_call_analysis": [
    {
      "type": "<string>",
      "name": "<string>",
      "description": "<string>",
      "system_prompt": "<string>",
      "examples": [
        "<string>"
      ]
    }
  ],
  "created_by_user_id": "<string>"
}

API Reference

AI Agents v2

Built-in Tools

Custom Tools

Calls

Post-call Analysis

Phone Numbers

Knowledge Bases

Knowledge Bases v2

Prompt Generation

Public Sharing

API Keys

Path Parameters

Body

Response