Skip to main content
PUT
Update assistant
This endpoint allows you to update an existing AI assistant’s configuration. All fields are optional - only provide the fields you want to update.

Path Parameters

integer
required
The unique identifier of the assistant to update

Request Body

Core Fields

string
The name of the assistant (max 255 characters)
integer
The voice ID to use for the assistant. Use the Get Voices endpoint with the mode parameter to get compatible voices for your engine mode.
integer
The language ID for the assistant. Use the Get Languages endpoint to get available languages.
string
The assistant type. Options: inbound, outbound
string
The engine mode. Options: pipeline, multimodal, dualplex
Changing the mode will reset mode-specific settings to defaults for the new mode.
string
The timezone for the assistant (e.g., “Europe/Bucharest”, “America/New_York”)
string
The initial message the assistant will speak when the call starts (max 200 characters)
string
The system prompt that defines the assistant’s behavior and personality

Mode-Specific Fields

integer
The LLM model ID to use. Only applies to pipeline mode.Use the Get Models endpoint to get available models.
integer
The multimodal model ID. Only applies to multimodal and dualplex modes.Use the Get Models endpoint to get available multimodal models.
integer
Fallback LLM model ID for tool calls in multimodal/dualplex modes. Set to null to remove.
number
Turn detection sensitivity for multimodal/dualplex modes (0-1). Set to null for auto.

Secondary Languages

integer[]
Array of additional language IDs the assistant can speak. Replaces existing secondary languages. Pass an empty array [] to remove all secondary languages.

Knowledgebase Settings

integer
The knowledgebase ID to attach. Set to null to remove knowledgebase.
string
How to use the knowledgebase. Options:
  • function_call - AI calls a function to search (required for multimodal/dualplex)
  • prompt - Knowledge is injected into prompt (pipeline only)

Phone Number

integer
The ID of a phone number to assign. Set to null to unassign. Must belong to your account.
For inbound assistants, the phone number cannot be a Caller ID type and cannot be already assigned to another inbound assistant.

Custom Mid-Call Tools

integer[]
Array of custom mid-call tool IDs to sync. Replaces all existing tool assignments. Pass an empty array [] to remove all tools. Each tool must belong to your account.

Built-in Tools

array
Array of built-in tools. Replaces all existing built-in tools. Pass an empty array [] to remove all tools.

Voice and TTS Settings

boolean
Whether to enable emotional text-to-speech synthesis
number
Voice stability setting (0-1). Higher = more consistent voice
number
Voice similarity setting (0-1). Higher = closer to original voice
number
Speech speed multiplier (0.7-1.2)
number
LLM temperature setting (0-1). Lower = more deterministic
integer
Custom TTS provider ID. Set to null to use language default.
integer
Custom STT provider ID. Pipeline mode only. Set to null to use language default.

Call Behavior Settings

boolean
Whether to allow caller interruptions.
Cannot be disabled for multimodal and dualplex modes.
boolean
Whether to use filler audio during processing.
Only available for pipeline mode.
boolean
Whether to record the call
boolean
Whether to enable noise cancellation
boolean
If true, the assistant waits for the customer to speak first

Timing Settings

integer
Maximum call duration in seconds (20-1200)
integer
Maximum silence duration before re-engagement in seconds (1-360)
integer
Maximum silence at call start before ending (1-120 seconds). Set to null to disable.
integer
Maximum ringing time before giving up (1-60 seconds)

Re-engagement Settings

integer
Re-engagement interval in seconds (7-600)
string
Custom prompt for re-engagement messages (max 1000 characters). Set to null to use default.

Voicemail Settings

boolean
Whether to end call when voicemail is detected
string
Message to leave on voicemail before hanging up (max 1000 characters). Set to null to disable.

Endpoint Detection

string
Voice activity detection type. Options: vad, ai
number
Endpoint sensitivity level (0-5)
number
Interrupt sensitivity level (0-5)
integer
Minimum words before interruption is allowed (0-10). Set to null to disable.

Ambient Sound

string
Background ambient sound. Options: off, office, city, forest, crowded_room, cafe, nature
number
Ambient sound volume level (0-1)

Webhook Configuration

boolean
Whether webhook notifications are enabled
string
The webhook URL for post-call notifications. Set to null to remove.
boolean
Whether to send webhooks only on completed calls (not failed/no-answer)
boolean
Whether to include recording URL in webhook payload

Post-Call Evaluation

boolean
Whether to enable AI post-call evaluation
array
Schema definition for post-call data extraction. Replaces existing schema.

Variables

object
Key-value pairs of custom variables. Replaces all existing variables.

Example Requests

Update Basic Settings

Switch to Multimodal Mode

Update Tools and Knowledgebase

Update Re-engagement and Voicemail

Remove Optional Settings


Response

string
Success message confirming assistant update
object

Notes

  • Only the fields you provide in the request body will be updated
  • To remove optional fields, explicitly set them to null
  • To clear arrays (tools, secondary languages), pass an empty array []
  • The assistant must belong to the authenticated user
  • Use the Get Voices endpoint with mode parameter to get compatible voices
  • For multimodal/dualplex modes, knowledgebase_mode must be function_call
  • For multimodal/dualplex modes, allow_interruptions cannot be disabled
  • Changing the mode resets mode-specific settings (LLM model, multimodal model, providers)