Create assistant

curl --request POST \
  --url https://api.example.com/user/assistant \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "voice_id": 123,
  "language_id": 123,
  "type": "<string>",
  "mode": "<string>",
  "timezone": "<string>",
  "initial_message": "<string>",
  "system_prompt": "<string>",
  "llm_model_id": 123,
  "multimodal_model_id": 123,
  "chat_llm_fallback_id": 123,
  "turn_detection_threshold": 123,
  "secondary_language_ids": [
    123
  ],
  "knowledgebase_id": 123,
  "knowledgebase_mode": "<string>",
  "phone_number_id": 123,
  "tool_ids": [
    123
  ],
  "tools": [
    {}
  ],
  "tts_emotion_enabled": true,
  "voice_stability": 123,
  "voice_similarity": 123,
  "speech_speed": 123,
  "llm_temperature": 123,
  "synthesizer_provider_id": 123,
  "transcriber_provider_id": 123,
  "allow_interruptions": true,
  "fillers": true,
  "filler_config": {},
  "record": true,
  "enable_noise_cancellation": true,
  "wait_for_customer": true,
  "max_duration": 123,
  "max_silence_duration": 123,
  "max_initial_silence_duration": 123,
  "ringing_time": 123,
  "reengagement_interval": 123,
  "reengagement_prompt": "<string>",
  "end_call_on_voicemail": true,
  "voice_mail_message": "<string>",
  "endpoint_type": "<string>",
  "endpoint_sensitivity": 123,
  "interrupt_sensitivity": 123,
  "min_interrupt_words": 123,
  "ambient_sound": "<string>",
  "ambient_sound_volume": 123,
  "is_webhook_active": true,
  "webhook_url": "<string>",
  "send_webhook_only_on_completed": true,
  "include_recording_in_webhook": true,
  "post_call_evaluation": true,
  "post_call_schema": [
    {
      "name": "<string>",
      "type": "<string>",
      "description": "<string>"
    }
  ],
  "variables": {},
  "conversation_inactivity_timeout": 123,
  "conversation_ended_retrigger": true,
  "conversation_ended_webhook_url": "<string>"
}
'

import requests

url = "https://api.example.com/user/assistant"

payload = {
    "name": "<string>",
    "voice_id": 123,
    "language_id": 123,
    "type": "<string>",
    "mode": "<string>",
    "timezone": "<string>",
    "initial_message": "<string>",
    "system_prompt": "<string>",
    "llm_model_id": 123,
    "multimodal_model_id": 123,
    "chat_llm_fallback_id": 123,
    "turn_detection_threshold": 123,
    "secondary_language_ids": [123],
    "knowledgebase_id": 123,
    "knowledgebase_mode": "<string>",
    "phone_number_id": 123,
    "tool_ids": [123],
    "tools": [{}],
    "tts_emotion_enabled": True,
    "voice_stability": 123,
    "voice_similarity": 123,
    "speech_speed": 123,
    "llm_temperature": 123,
    "synthesizer_provider_id": 123,
    "transcriber_provider_id": 123,
    "allow_interruptions": True,
    "fillers": True,
    "filler_config": {},
    "record": True,
    "enable_noise_cancellation": True,
    "wait_for_customer": True,
    "max_duration": 123,
    "max_silence_duration": 123,
    "max_initial_silence_duration": 123,
    "ringing_time": 123,
    "reengagement_interval": 123,
    "reengagement_prompt": "<string>",
    "end_call_on_voicemail": True,
    "voice_mail_message": "<string>",
    "endpoint_type": "<string>",
    "endpoint_sensitivity": 123,
    "interrupt_sensitivity": 123,
    "min_interrupt_words": 123,
    "ambient_sound": "<string>",
    "ambient_sound_volume": 123,
    "is_webhook_active": True,
    "webhook_url": "<string>",
    "send_webhook_only_on_completed": True,
    "include_recording_in_webhook": True,
    "post_call_evaluation": True,
    "post_call_schema": [
        {
            "name": "<string>",
            "type": "<string>",
            "description": "<string>"
        }
    ],
    "variables": {},
    "conversation_inactivity_timeout": 123,
    "conversation_ended_retrigger": True,
    "conversation_ended_webhook_url": "<string>"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    voice_id: 123,
    language_id: 123,
    type: '<string>',
    mode: '<string>',
    timezone: '<string>',
    initial_message: '<string>',
    system_prompt: '<string>',
    llm_model_id: 123,
    multimodal_model_id: 123,
    chat_llm_fallback_id: 123,
    turn_detection_threshold: 123,
    secondary_language_ids: [123],
    knowledgebase_id: 123,
    knowledgebase_mode: '<string>',
    phone_number_id: 123,
    tool_ids: [123],
    tools: [{}],
    tts_emotion_enabled: true,
    voice_stability: 123,
    voice_similarity: 123,
    speech_speed: 123,
    llm_temperature: 123,
    synthesizer_provider_id: 123,
    transcriber_provider_id: 123,
    allow_interruptions: true,
    fillers: true,
    filler_config: {},
    record: true,
    enable_noise_cancellation: true,
    wait_for_customer: true,
    max_duration: 123,
    max_silence_duration: 123,
    max_initial_silence_duration: 123,
    ringing_time: 123,
    reengagement_interval: 123,
    reengagement_prompt: '<string>',
    end_call_on_voicemail: true,
    voice_mail_message: '<string>',
    endpoint_type: '<string>',
    endpoint_sensitivity: 123,
    interrupt_sensitivity: 123,
    min_interrupt_words: 123,
    ambient_sound: '<string>',
    ambient_sound_volume: 123,
    is_webhook_active: true,
    webhook_url: '<string>',
    send_webhook_only_on_completed: true,
    include_recording_in_webhook: true,
    post_call_evaluation: true,
    post_call_schema: [{name: '<string>', type: '<string>', description: '<string>'}],
    variables: {},
    conversation_inactivity_timeout: 123,
    conversation_ended_retrigger: true,
    conversation_ended_webhook_url: '<string>'
  })
};

fetch('https://api.example.com/user/assistant', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/user/assistant",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'voice_id' => 123,
    'language_id' => 123,
    'type' => '<string>',
    'mode' => '<string>',
    'timezone' => '<string>',
    'initial_message' => '<string>',
    'system_prompt' => '<string>',
    'llm_model_id' => 123,
    'multimodal_model_id' => 123,
    'chat_llm_fallback_id' => 123,
    'turn_detection_threshold' => 123,
    'secondary_language_ids' => [
        123
    ],
    'knowledgebase_id' => 123,
    'knowledgebase_mode' => '<string>',
    'phone_number_id' => 123,
    'tool_ids' => [
        123
    ],
    'tools' => [
        [
                
        ]
    ],
    'tts_emotion_enabled' => true,
    'voice_stability' => 123,
    'voice_similarity' => 123,
    'speech_speed' => 123,
    'llm_temperature' => 123,
    'synthesizer_provider_id' => 123,
    'transcriber_provider_id' => 123,
    'allow_interruptions' => true,
    'fillers' => true,
    'filler_config' => [
        
    ],
    'record' => true,
    'enable_noise_cancellation' => true,
    'wait_for_customer' => true,
    'max_duration' => 123,
    'max_silence_duration' => 123,
    'max_initial_silence_duration' => 123,
    'ringing_time' => 123,
    'reengagement_interval' => 123,
    'reengagement_prompt' => '<string>',
    'end_call_on_voicemail' => true,
    'voice_mail_message' => '<string>',
    'endpoint_type' => '<string>',
    'endpoint_sensitivity' => 123,
    'interrupt_sensitivity' => 123,
    'min_interrupt_words' => 123,
    'ambient_sound' => '<string>',
    'ambient_sound_volume' => 123,
    'is_webhook_active' => true,
    'webhook_url' => '<string>',
    'send_webhook_only_on_completed' => true,
    'include_recording_in_webhook' => true,
    'post_call_evaluation' => true,
    'post_call_schema' => [
        [
                'name' => '<string>',
                'type' => '<string>',
                'description' => '<string>'
        ]
    ],
    'variables' => [
        
    ],
    'conversation_inactivity_timeout' => 123,
    'conversation_ended_retrigger' => true,
    'conversation_ended_webhook_url' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/user/assistant"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"voice_id\": 123,\n  \"language_id\": 123,\n  \"type\": \"<string>\",\n  \"mode\": \"<string>\",\n  \"timezone\": \"<string>\",\n  \"initial_message\": \"<string>\",\n  \"system_prompt\": \"<string>\",\n  \"llm_model_id\": 123,\n  \"multimodal_model_id\": 123,\n  \"chat_llm_fallback_id\": 123,\n  \"turn_detection_threshold\": 123,\n  \"secondary_language_ids\": [\n    123\n  ],\n  \"knowledgebase_id\": 123,\n  \"knowledgebase_mode\": \"<string>\",\n  \"phone_number_id\": 123,\n  \"tool_ids\": [\n    123\n  ],\n  \"tools\": [\n    {}\n  ],\n  \"tts_emotion_enabled\": true,\n  \"voice_stability\": 123,\n  \"voice_similarity\": 123,\n  \"speech_speed\": 123,\n  \"llm_temperature\": 123,\n  \"synthesizer_provider_id\": 123,\n  \"transcriber_provider_id\": 123,\n  \"allow_interruptions\": true,\n  \"fillers\": true,\n  \"filler_config\": {},\n  \"record\": true,\n  \"enable_noise_cancellation\": true,\n  \"wait_for_customer\": true,\n  \"max_duration\": 123,\n  \"max_silence_duration\": 123,\n  \"max_initial_silence_duration\": 123,\n  \"ringing_time\": 123,\n  \"reengagement_interval\": 123,\n  \"reengagement_prompt\": \"<string>\",\n  \"end_call_on_voicemail\": true,\n  \"voice_mail_message\": \"<string>\",\n  \"endpoint_type\": \"<string>\",\n  \"endpoint_sensitivity\": 123,\n  \"interrupt_sensitivity\": 123,\n  \"min_interrupt_words\": 123,\n  \"ambient_sound\": \"<string>\",\n  \"ambient_sound_volume\": 123,\n  \"is_webhook_active\": true,\n  \"webhook_url\": \"<string>\",\n  \"send_webhook_only_on_completed\": true,\n  \"include_recording_in_webhook\": true,\n  \"post_call_evaluation\": true,\n  \"post_call_schema\": [\n    {\n      \"name\": \"<string>\",\n      \"type\": \"<string>\",\n      \"description\": \"<string>\"\n    }\n  ],\n  \"variables\": {},\n  \"conversation_inactivity_timeout\": 123,\n  \"conversation_ended_retrigger\": true,\n  \"conversation_ended_webhook_url\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.example.com/user/assistant")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"voice_id\": 123,\n  \"language_id\": 123,\n  \"type\": \"<string>\",\n  \"mode\": \"<string>\",\n  \"timezone\": \"<string>\",\n  \"initial_message\": \"<string>\",\n  \"system_prompt\": \"<string>\",\n  \"llm_model_id\": 123,\n  \"multimodal_model_id\": 123,\n  \"chat_llm_fallback_id\": 123,\n  \"turn_detection_threshold\": 123,\n  \"secondary_language_ids\": [\n    123\n  ],\n  \"knowledgebase_id\": 123,\n  \"knowledgebase_mode\": \"<string>\",\n  \"phone_number_id\": 123,\n  \"tool_ids\": [\n    123\n  ],\n  \"tools\": [\n    {}\n  ],\n  \"tts_emotion_enabled\": true,\n  \"voice_stability\": 123,\n  \"voice_similarity\": 123,\n  \"speech_speed\": 123,\n  \"llm_temperature\": 123,\n  \"synthesizer_provider_id\": 123,\n  \"transcriber_provider_id\": 123,\n  \"allow_interruptions\": true,\n  \"fillers\": true,\n  \"filler_config\": {},\n  \"record\": true,\n  \"enable_noise_cancellation\": true,\n  \"wait_for_customer\": true,\n  \"max_duration\": 123,\n  \"max_silence_duration\": 123,\n  \"max_initial_silence_duration\": 123,\n  \"ringing_time\": 123,\n  \"reengagement_interval\": 123,\n  \"reengagement_prompt\": \"<string>\",\n  \"end_call_on_voicemail\": true,\n  \"voice_mail_message\": \"<string>\",\n  \"endpoint_type\": \"<string>\",\n  \"endpoint_sensitivity\": 123,\n  \"interrupt_sensitivity\": 123,\n  \"min_interrupt_words\": 123,\n  \"ambient_sound\": \"<string>\",\n  \"ambient_sound_volume\": 123,\n  \"is_webhook_active\": true,\n  \"webhook_url\": \"<string>\",\n  \"send_webhook_only_on_completed\": true,\n  \"include_recording_in_webhook\": true,\n  \"post_call_evaluation\": true,\n  \"post_call_schema\": [\n    {\n      \"name\": \"<string>\",\n      \"type\": \"<string>\",\n      \"description\": \"<string>\"\n    }\n  ],\n  \"variables\": {},\n  \"conversation_inactivity_timeout\": 123,\n  \"conversation_ended_retrigger\": true,\n  \"conversation_ended_webhook_url\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/user/assistant")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"voice_id\": 123,\n  \"language_id\": 123,\n  \"type\": \"<string>\",\n  \"mode\": \"<string>\",\n  \"timezone\": \"<string>\",\n  \"initial_message\": \"<string>\",\n  \"system_prompt\": \"<string>\",\n  \"llm_model_id\": 123,\n  \"multimodal_model_id\": 123,\n  \"chat_llm_fallback_id\": 123,\n  \"turn_detection_threshold\": 123,\n  \"secondary_language_ids\": [\n    123\n  ],\n  \"knowledgebase_id\": 123,\n  \"knowledgebase_mode\": \"<string>\",\n  \"phone_number_id\": 123,\n  \"tool_ids\": [\n    123\n  ],\n  \"tools\": [\n    {}\n  ],\n  \"tts_emotion_enabled\": true,\n  \"voice_stability\": 123,\n  \"voice_similarity\": 123,\n  \"speech_speed\": 123,\n  \"llm_temperature\": 123,\n  \"synthesizer_provider_id\": 123,\n  \"transcriber_provider_id\": 123,\n  \"allow_interruptions\": true,\n  \"fillers\": true,\n  \"filler_config\": {},\n  \"record\": true,\n  \"enable_noise_cancellation\": true,\n  \"wait_for_customer\": true,\n  \"max_duration\": 123,\n  \"max_silence_duration\": 123,\n  \"max_initial_silence_duration\": 123,\n  \"ringing_time\": 123,\n  \"reengagement_interval\": 123,\n  \"reengagement_prompt\": \"<string>\",\n  \"end_call_on_voicemail\": true,\n  \"voice_mail_message\": \"<string>\",\n  \"endpoint_type\": \"<string>\",\n  \"endpoint_sensitivity\": 123,\n  \"interrupt_sensitivity\": 123,\n  \"min_interrupt_words\": 123,\n  \"ambient_sound\": \"<string>\",\n  \"ambient_sound_volume\": 123,\n  \"is_webhook_active\": true,\n  \"webhook_url\": \"<string>\",\n  \"send_webhook_only_on_completed\": true,\n  \"include_recording_in_webhook\": true,\n  \"post_call_evaluation\": true,\n  \"post_call_schema\": [\n    {\n      \"name\": \"<string>\",\n      \"type\": \"<string>\",\n      \"description\": \"<string>\"\n    }\n  ],\n  \"variables\": {},\n  \"conversation_inactivity_timeout\": 123,\n  \"conversation_ended_retrigger\": true,\n  \"conversation_ended_webhook_url\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "message": "Assistant created successfully",
  "data": {
    "id": 789,
    "name": "Sales Assistant",
    "status": "inactive",
    "type": "outbound",
    "mode": "pipeline"
  }
}

{
  "message": "Validation failed",
  "errors": {
    "name": ["The name field is required."],
    "voice_id": ["The selected voice is not compatible with the chosen engine type."],
    "knowledgebase_mode": ["Only function_call mode is available for multimodal assistants."]
  }
}

POST

user

assistant

Create assistant

curl --request POST \
  --url https://api.example.com/user/assistant \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "voice_id": 123,
  "language_id": 123,
  "type": "<string>",
  "mode": "<string>",
  "timezone": "<string>",
  "initial_message": "<string>",
  "system_prompt": "<string>",
  "llm_model_id": 123,
  "multimodal_model_id": 123,
  "chat_llm_fallback_id": 123,
  "turn_detection_threshold": 123,
  "secondary_language_ids": [
    123
  ],
  "knowledgebase_id": 123,
  "knowledgebase_mode": "<string>",
  "phone_number_id": 123,
  "tool_ids": [
    123
  ],
  "tools": [
    {}
  ],
  "tts_emotion_enabled": true,
  "voice_stability": 123,
  "voice_similarity": 123,
  "speech_speed": 123,
  "llm_temperature": 123,
  "synthesizer_provider_id": 123,
  "transcriber_provider_id": 123,
  "allow_interruptions": true,
  "fillers": true,
  "filler_config": {},
  "record": true,
  "enable_noise_cancellation": true,
  "wait_for_customer": true,
  "max_duration": 123,
  "max_silence_duration": 123,
  "max_initial_silence_duration": 123,
  "ringing_time": 123,
  "reengagement_interval": 123,
  "reengagement_prompt": "<string>",
  "end_call_on_voicemail": true,
  "voice_mail_message": "<string>",
  "endpoint_type": "<string>",
  "endpoint_sensitivity": 123,
  "interrupt_sensitivity": 123,
  "min_interrupt_words": 123,
  "ambient_sound": "<string>",
  "ambient_sound_volume": 123,
  "is_webhook_active": true,
  "webhook_url": "<string>",
  "send_webhook_only_on_completed": true,
  "include_recording_in_webhook": true,
  "post_call_evaluation": true,
  "post_call_schema": [
    {
      "name": "<string>",
      "type": "<string>",
      "description": "<string>"
    }
  ],
  "variables": {},
  "conversation_inactivity_timeout": 123,
  "conversation_ended_retrigger": true,
  "conversation_ended_webhook_url": "<string>"
}
'

import requests

url = "https://api.example.com/user/assistant"

payload = {
    "name": "<string>",
    "voice_id": 123,
    "language_id": 123,
    "type": "<string>",
    "mode": "<string>",
    "timezone": "<string>",
    "initial_message": "<string>",
    "system_prompt": "<string>",
    "llm_model_id": 123,
    "multimodal_model_id": 123,
    "chat_llm_fallback_id": 123,
    "turn_detection_threshold": 123,
    "secondary_language_ids": [123],
    "knowledgebase_id": 123,
    "knowledgebase_mode": "<string>",
    "phone_number_id": 123,
    "tool_ids": [123],
    "tools": [{}],
    "tts_emotion_enabled": True,
    "voice_stability": 123,
    "voice_similarity": 123,
    "speech_speed": 123,
    "llm_temperature": 123,
    "synthesizer_provider_id": 123,
    "transcriber_provider_id": 123,
    "allow_interruptions": True,
    "fillers": True,
    "filler_config": {},
    "record": True,
    "enable_noise_cancellation": True,
    "wait_for_customer": True,
    "max_duration": 123,
    "max_silence_duration": 123,
    "max_initial_silence_duration": 123,
    "ringing_time": 123,
    "reengagement_interval": 123,
    "reengagement_prompt": "<string>",
    "end_call_on_voicemail": True,
    "voice_mail_message": "<string>",
    "endpoint_type": "<string>",
    "endpoint_sensitivity": 123,
    "interrupt_sensitivity": 123,
    "min_interrupt_words": 123,
    "ambient_sound": "<string>",
    "ambient_sound_volume": 123,
    "is_webhook_active": True,
    "webhook_url": "<string>",
    "send_webhook_only_on_completed": True,
    "include_recording_in_webhook": True,
    "post_call_evaluation": True,
    "post_call_schema": [
        {
            "name": "<string>",
            "type": "<string>",
            "description": "<string>"
        }
    ],
    "variables": {},
    "conversation_inactivity_timeout": 123,
    "conversation_ended_retrigger": True,
    "conversation_ended_webhook_url": "<string>"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    voice_id: 123,
    language_id: 123,
    type: '<string>',
    mode: '<string>',
    timezone: '<string>',
    initial_message: '<string>',
    system_prompt: '<string>',
    llm_model_id: 123,
    multimodal_model_id: 123,
    chat_llm_fallback_id: 123,
    turn_detection_threshold: 123,
    secondary_language_ids: [123],
    knowledgebase_id: 123,
    knowledgebase_mode: '<string>',
    phone_number_id: 123,
    tool_ids: [123],
    tools: [{}],
    tts_emotion_enabled: true,
    voice_stability: 123,
    voice_similarity: 123,
    speech_speed: 123,
    llm_temperature: 123,
    synthesizer_provider_id: 123,
    transcriber_provider_id: 123,
    allow_interruptions: true,
    fillers: true,
    filler_config: {},
    record: true,
    enable_noise_cancellation: true,
    wait_for_customer: true,
    max_duration: 123,
    max_silence_duration: 123,
    max_initial_silence_duration: 123,
    ringing_time: 123,
    reengagement_interval: 123,
    reengagement_prompt: '<string>',
    end_call_on_voicemail: true,
    voice_mail_message: '<string>',
    endpoint_type: '<string>',
    endpoint_sensitivity: 123,
    interrupt_sensitivity: 123,
    min_interrupt_words: 123,
    ambient_sound: '<string>',
    ambient_sound_volume: 123,
    is_webhook_active: true,
    webhook_url: '<string>',
    send_webhook_only_on_completed: true,
    include_recording_in_webhook: true,
    post_call_evaluation: true,
    post_call_schema: [{name: '<string>', type: '<string>', description: '<string>'}],
    variables: {},
    conversation_inactivity_timeout: 123,
    conversation_ended_retrigger: true,
    conversation_ended_webhook_url: '<string>'
  })
};

fetch('https://api.example.com/user/assistant', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/user/assistant",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'voice_id' => 123,
    'language_id' => 123,
    'type' => '<string>',
    'mode' => '<string>',
    'timezone' => '<string>',
    'initial_message' => '<string>',
    'system_prompt' => '<string>',
    'llm_model_id' => 123,
    'multimodal_model_id' => 123,
    'chat_llm_fallback_id' => 123,
    'turn_detection_threshold' => 123,
    'secondary_language_ids' => [
        123
    ],
    'knowledgebase_id' => 123,
    'knowledgebase_mode' => '<string>',
    'phone_number_id' => 123,
    'tool_ids' => [
        123
    ],
    'tools' => [
        [
                
        ]
    ],
    'tts_emotion_enabled' => true,
    'voice_stability' => 123,
    'voice_similarity' => 123,
    'speech_speed' => 123,
    'llm_temperature' => 123,
    'synthesizer_provider_id' => 123,
    'transcriber_provider_id' => 123,
    'allow_interruptions' => true,
    'fillers' => true,
    'filler_config' => [
        
    ],
    'record' => true,
    'enable_noise_cancellation' => true,
    'wait_for_customer' => true,
    'max_duration' => 123,
    'max_silence_duration' => 123,
    'max_initial_silence_duration' => 123,
    'ringing_time' => 123,
    'reengagement_interval' => 123,
    'reengagement_prompt' => '<string>',
    'end_call_on_voicemail' => true,
    'voice_mail_message' => '<string>',
    'endpoint_type' => '<string>',
    'endpoint_sensitivity' => 123,
    'interrupt_sensitivity' => 123,
    'min_interrupt_words' => 123,
    'ambient_sound' => '<string>',
    'ambient_sound_volume' => 123,
    'is_webhook_active' => true,
    'webhook_url' => '<string>',
    'send_webhook_only_on_completed' => true,
    'include_recording_in_webhook' => true,
    'post_call_evaluation' => true,
    'post_call_schema' => [
        [
                'name' => '<string>',
                'type' => '<string>',
                'description' => '<string>'
        ]
    ],
    'variables' => [
        
    ],
    'conversation_inactivity_timeout' => 123,
    'conversation_ended_retrigger' => true,
    'conversation_ended_webhook_url' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/user/assistant"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"voice_id\": 123,\n  \"language_id\": 123,\n  \"type\": \"<string>\",\n  \"mode\": \"<string>\",\n  \"timezone\": \"<string>\",\n  \"initial_message\": \"<string>\",\n  \"system_prompt\": \"<string>\",\n  \"llm_model_id\": 123,\n  \"multimodal_model_id\": 123,\n  \"chat_llm_fallback_id\": 123,\n  \"turn_detection_threshold\": 123,\n  \"secondary_language_ids\": [\n    123\n  ],\n  \"knowledgebase_id\": 123,\n  \"knowledgebase_mode\": \"<string>\",\n  \"phone_number_id\": 123,\n  \"tool_ids\": [\n    123\n  ],\n  \"tools\": [\n    {}\n  ],\n  \"tts_emotion_enabled\": true,\n  \"voice_stability\": 123,\n  \"voice_similarity\": 123,\n  \"speech_speed\": 123,\n  \"llm_temperature\": 123,\n  \"synthesizer_provider_id\": 123,\n  \"transcriber_provider_id\": 123,\n  \"allow_interruptions\": true,\n  \"fillers\": true,\n  \"filler_config\": {},\n  \"record\": true,\n  \"enable_noise_cancellation\": true,\n  \"wait_for_customer\": true,\n  \"max_duration\": 123,\n  \"max_silence_duration\": 123,\n  \"max_initial_silence_duration\": 123,\n  \"ringing_time\": 123,\n  \"reengagement_interval\": 123,\n  \"reengagement_prompt\": \"<string>\",\n  \"end_call_on_voicemail\": true,\n  \"voice_mail_message\": \"<string>\",\n  \"endpoint_type\": \"<string>\",\n  \"endpoint_sensitivity\": 123,\n  \"interrupt_sensitivity\": 123,\n  \"min_interrupt_words\": 123,\n  \"ambient_sound\": \"<string>\",\n  \"ambient_sound_volume\": 123,\n  \"is_webhook_active\": true,\n  \"webhook_url\": \"<string>\",\n  \"send_webhook_only_on_completed\": true,\n  \"include_recording_in_webhook\": true,\n  \"post_call_evaluation\": true,\n  \"post_call_schema\": [\n    {\n      \"name\": \"<string>\",\n      \"type\": \"<string>\",\n      \"description\": \"<string>\"\n    }\n  ],\n  \"variables\": {},\n  \"conversation_inactivity_timeout\": 123,\n  \"conversation_ended_retrigger\": true,\n  \"conversation_ended_webhook_url\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.example.com/user/assistant")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"voice_id\": 123,\n  \"language_id\": 123,\n  \"type\": \"<string>\",\n  \"mode\": \"<string>\",\n  \"timezone\": \"<string>\",\n  \"initial_message\": \"<string>\",\n  \"system_prompt\": \"<string>\",\n  \"llm_model_id\": 123,\n  \"multimodal_model_id\": 123,\n  \"chat_llm_fallback_id\": 123,\n  \"turn_detection_threshold\": 123,\n  \"secondary_language_ids\": [\n    123\n  ],\n  \"knowledgebase_id\": 123,\n  \"knowledgebase_mode\": \"<string>\",\n  \"phone_number_id\": 123,\n  \"tool_ids\": [\n    123\n  ],\n  \"tools\": [\n    {}\n  ],\n  \"tts_emotion_enabled\": true,\n  \"voice_stability\": 123,\n  \"voice_similarity\": 123,\n  \"speech_speed\": 123,\n  \"llm_temperature\": 123,\n  \"synthesizer_provider_id\": 123,\n  \"transcriber_provider_id\": 123,\n  \"allow_interruptions\": true,\n  \"fillers\": true,\n  \"filler_config\": {},\n  \"record\": true,\n  \"enable_noise_cancellation\": true,\n  \"wait_for_customer\": true,\n  \"max_duration\": 123,\n  \"max_silence_duration\": 123,\n  \"max_initial_silence_duration\": 123,\n  \"ringing_time\": 123,\n  \"reengagement_interval\": 123,\n  \"reengagement_prompt\": \"<string>\",\n  \"end_call_on_voicemail\": true,\n  \"voice_mail_message\": \"<string>\",\n  \"endpoint_type\": \"<string>\",\n  \"endpoint_sensitivity\": 123,\n  \"interrupt_sensitivity\": 123,\n  \"min_interrupt_words\": 123,\n  \"ambient_sound\": \"<string>\",\n  \"ambient_sound_volume\": 123,\n  \"is_webhook_active\": true,\n  \"webhook_url\": \"<string>\",\n  \"send_webhook_only_on_completed\": true,\n  \"include_recording_in_webhook\": true,\n  \"post_call_evaluation\": true,\n  \"post_call_schema\": [\n    {\n      \"name\": \"<string>\",\n      \"type\": \"<string>\",\n      \"description\": \"<string>\"\n    }\n  ],\n  \"variables\": {},\n  \"conversation_inactivity_timeout\": 123,\n  \"conversation_ended_retrigger\": true,\n  \"conversation_ended_webhook_url\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/user/assistant")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"voice_id\": 123,\n  \"language_id\": 123,\n  \"type\": \"<string>\",\n  \"mode\": \"<string>\",\n  \"timezone\": \"<string>\",\n  \"initial_message\": \"<string>\",\n  \"system_prompt\": \"<string>\",\n  \"llm_model_id\": 123,\n  \"multimodal_model_id\": 123,\n  \"chat_llm_fallback_id\": 123,\n  \"turn_detection_threshold\": 123,\n  \"secondary_language_ids\": [\n    123\n  ],\n  \"knowledgebase_id\": 123,\n  \"knowledgebase_mode\": \"<string>\",\n  \"phone_number_id\": 123,\n  \"tool_ids\": [\n    123\n  ],\n  \"tools\": [\n    {}\n  ],\n  \"tts_emotion_enabled\": true,\n  \"voice_stability\": 123,\n  \"voice_similarity\": 123,\n  \"speech_speed\": 123,\n  \"llm_temperature\": 123,\n  \"synthesizer_provider_id\": 123,\n  \"transcriber_provider_id\": 123,\n  \"allow_interruptions\": true,\n  \"fillers\": true,\n  \"filler_config\": {},\n  \"record\": true,\n  \"enable_noise_cancellation\": true,\n  \"wait_for_customer\": true,\n  \"max_duration\": 123,\n  \"max_silence_duration\": 123,\n  \"max_initial_silence_duration\": 123,\n  \"ringing_time\": 123,\n  \"reengagement_interval\": 123,\n  \"reengagement_prompt\": \"<string>\",\n  \"end_call_on_voicemail\": true,\n  \"voice_mail_message\": \"<string>\",\n  \"endpoint_type\": \"<string>\",\n  \"endpoint_sensitivity\": 123,\n  \"interrupt_sensitivity\": 123,\n  \"min_interrupt_words\": 123,\n  \"ambient_sound\": \"<string>\",\n  \"ambient_sound_volume\": 123,\n  \"is_webhook_active\": true,\n  \"webhook_url\": \"<string>\",\n  \"send_webhook_only_on_completed\": true,\n  \"include_recording_in_webhook\": true,\n  \"post_call_evaluation\": true,\n  \"post_call_schema\": [\n    {\n      \"name\": \"<string>\",\n      \"type\": \"<string>\",\n      \"description\": \"<string>\"\n    }\n  ],\n  \"variables\": {},\n  \"conversation_inactivity_timeout\": 123,\n  \"conversation_ended_retrigger\": true,\n  \"conversation_ended_webhook_url\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "message": "Assistant created successfully",
  "data": {
    "id": 789,
    "name": "Sales Assistant",
    "status": "inactive",
    "type": "outbound",
    "mode": "pipeline"
  }
}

{
  "message": "Validation failed",
  "errors": {
    "name": ["The name field is required."],
    "voice_id": ["The selected voice is not compatible with the chosen engine type."],
    "knowledgebase_mode": ["Only function_call mode is available for multimodal assistants."]
  }
}

This endpoint allows you to create a new AI assistant with comprehensive configuration options.

Engine Modes

The API supports three engine modes, each with different capabilities:

Mode	Description	Required Fields
`pipeline`	Traditional STT → LLM → TTS pipeline	`llm_model_id`
`multimodal`	Real-time multimodal AI	`multimodal_model_id`
`dualplex`	Multimodal brain + custom TTS voice	`multimodal_model_id`

Request Body

Core Required Fields

string

required

The name of the assistant (max 255 characters)

integer

required

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

required

The language ID for the assistant. Use the Get Languages endpoint to get available languages.

string

required

The assistant type. Options: inbound, outbound

string

required

The engine mode. Options: pipeline, multimodal, dualplex

string

required

The timezone for the assistant (e.g., “Europe/Bucharest”, “America/New_York”)

string

required

The initial message the assistant will speak when the call starts (max 200 characters)

string

required

The system prompt that defines the assistant’s behavior and personality

Mode-Specific Fields

integer

The LLM model ID to use. Required for pipeline mode.Use the Get Models endpoint to get available models.

integer

The multimodal model ID. Required for 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. Optional.

number

Turn detection sensitivity for multimodal/dualplex modes (0-1). Default: auto

Secondary Languages

integer[]

Array of additional language IDs the assistant can speak. The assistant will auto-detect and switch languages.

"secondary_language_ids": [2, 3, 4]

Knowledgebase Settings

integer

The knowledgebase ID to attach to this assistant

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 to the assistant. 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 attach. Each tool must belong to your account.

"tool_ids": [1, 5, 12]

Built-in Tools

array

Array of built-in tools to enable. Each tool has a type and tool-specific fields.

Show Tool types

call_transfer - Transfer the call to another phone number

phone_number (required): Phone number to transfer to (e.g., “+1234567890”)
description: When to transfer the call
custom: If true, AI can determine transfer number dynamically
timezone: Timezone for transfer availability
warm_transfer: Send a message to the customer before transferring (default: false)
warm_transfer_message: Prompt telling the AI what to say before transferring (e.g., “Tell the customer that the call is being transferred.”)

warm_call_transfer - Warm transfer with supervisor briefing

supervisor_phone (required): Phone number to dial for the warm transfer (e.g., “+14155552001”). If custom_sip is enabled, this is a SIP address or internal extension instead.
outbound_phone_id (required): ID of the phone number used to dial the supervisor. Use Get Phone Numbers to find available numbers.
description (required): When to transfer — describes when the AI should initiate the warm transfer (e.g., “Transfer the call to a human supervisor when the customer requests to speak with a real person.”)
custom_sip: Enable to enter a custom SIP address or internal extension instead of a phone number (default: false)
caller_id_mode: What phone number the supervisor sees when receiving the call. Options: outbound_number (default — shows the outbound phone number), customer_number (shows the caller’s number), custom (shows a custom number)
custom_caller_id: Custom phone number shown to supervisor. Only used when caller_id_mode is custom.
hold_music: Audio played to the caller while on hold. Options: hold_music (default — plays default hold music), none (silence, no music)
hold_music_volume: Volume level for hold music, 0-100 (default: 80)
hold_message: Message spoken to caller before placing them on hold (default: “Please hold while I connect you with a supervisor.”)
summary_instructions: Instructions for how the AI should brief the supervisor about the call (default: “Introduce the conversation from your perspective:\n- WHO is calling (name, company if mentioned)\n- WHY they called (their goal or problem)\n- WHY a human is needed at this point\n\nKeep it brief (2-3 sentences).”)
briefing_initial_message: The first message the AI says to the supervisor when they answer (default: “Hello! I have a caller on the line who needs your assistance. May I brief you on the situation?”)
connected_message: Message spoken to caller after supervisor is connected (default: “You are now connected with a supervisor. I’ll leave you to it.”)

end_call - End the call programmatically

description: When the AI should end the call

dtmf_input - Send DTMF tones (keypad input)

description: When to use DTMF input (for IVR navigation)

collect_keypad - Collect keypad input from the caller

timeout: Seconds to wait for input, 1-30 (default: 5)
stop_key: Key that ends input. Options: # (default), *

calendar_integration - Schedule appointments via Cal.com

calcom_api_key (required): Your Cal.com API key
calcom_event_slug (required): The event type slug from Cal.com
calcom_team_slug: Team slug if the event belongs to a Cal.com team
calcom_endpoint: Cal.com API region. Options: us (default — https://api.cal.com), eu (https://api.cal.eu), custom (uses calcom_custom_endpoint)
calcom_custom_endpoint: Custom Cal.com API base URL. Only used when calcom_endpoint is custom (e.g., https://my-calcom-instance.com).
calcom_booking_fields: Array of custom booking fields for the event. Each field has:
- slug (required): Field identifier
- type (required): Field type (e.g., “text”, “email”, “phone”, “select”)
- label (required): Display label
- required: Whether the field is required (default: false)
- options: Array of options for select fields
description: When to offer scheduling

"tools": [
  {
    "type": "call_transfer",
    "phone_number": "+1234567890",
    "description": "Transfer when customer requests human support"
  },
  {
    "type": "warm_call_transfer",
    "supervisor_phone": "+1234567891",
    "outbound_phone_id": 7,
    "description": "Transfer the call to a human supervisor when the customer requests to speak with a real person.",
    "custom_sip": false,
    "caller_id_mode": "outbound_number",
    "hold_music": "hold_music",
    "hold_music_volume": 80,
    "hold_message": "Please hold while I connect you with a supervisor.",
    "summary_instructions": "Introduce the conversation from your perspective:\n- WHO is calling (name, company if mentioned)\n- WHY they called (their goal or problem)\n- WHY a human is needed at this point\n\nKeep it brief (2-3 sentences).",
    "briefing_initial_message": "Hello! I have a caller on the line who needs your assistance. May I brief you on the situation?",
    "connected_message": "You are now connected with a supervisor. I'll leave you to it."
  },
  {
    "type": "collect_keypad",
    "timeout": 5,
    "stop_key": "#"
  },
  {
    "type": "end_call",
    "description": "End call when customer confirms satisfaction"
  }
]

Voice and TTS Settings

boolean

default:"true"

Whether to enable emotional text-to-speech synthesis

number

default:"0.70"

Voice stability setting (0-1). Higher = more consistent voice

number

default:"0.50"

Voice similarity setting (0-1). Higher = closer to original voice

number

default:"1.00"

Speech speed multiplier (0.7-1.2)

number

default:"0.10"

LLM temperature setting (0-1). Lower = more deterministic

integer

Custom TTS provider ID. Auto-selected based on language if not provided. Use the Get Synthesizer Providers endpoint to discover available providers.

integer

Custom STT provider ID. Auto-selected based on language if not provided. Pipeline mode only. Use the Get Transcriber Providers endpoint to discover available providers.

Call Behavior Settings

boolean

default:"true"

Whether to allow caller interruptions.

Cannot be disabled for multimodal and dualplex modes.

boolean

default:"false"

Whether to use filler audio during processing (e.g., “um”, “let me check”).

Only available for pipeline mode.

object

Custom filler word profiles per category. If not provided, defaults are set based on the assistant’s language. Each category is an array of short phrases.

positive: Filler words for positive/affirmative responses (e.g., “Great!”, “Perfect!”)
negative: Filler words for negative/neutral responses (e.g., “Hmm.”, “Mhm.”)
question: Filler words when processing a question (e.g., “Hmm.”, “Let me think.”)
neutral: Filler words for neutral acknowledgments (e.g., “Ok.”, “I understand.”)

"filler_config": {
  "positive": ["Super!", "Great!", "Perfect!"],
  "negative": ["Hmm.", "Mhm.", "I see."],
  "question": ["Hmm.", "Let me check.", "Good question."],
  "neutral": ["Ok.", "I understand.", "Noted."]
}

boolean

default:"false"

Whether to record the call

boolean

default:"true"

Whether to enable noise cancellation

boolean

default:"false"

If true, the assistant waits for the customer to speak first

Timing Settings

integer

default:"600"

Maximum call duration in seconds (20-1200)

integer

default:"40"

Maximum silence duration before re-engagement in seconds (1-360)

integer

Maximum silence at call start before ending (1-120 seconds). Optional.

integer

default:"30"

Maximum ringing time before giving up (1-60 seconds)

Re-engagement Settings

integer

default:"30"

Re-engagement interval in seconds (7-600)

string

Custom prompt for re-engagement messages (max 1000 characters)Example: "Are you still there? Do you have any other questions?"

Voicemail Settings

boolean

default:"true"

Whether to end call when voicemail is detected

string

Message to leave on voicemail before hanging up (max 1000 characters)

Endpoint Detection

string

default:"vad"

Voice activity detection type. Options: vad, ai

number

default:"0.5"

Endpoint sensitivity level (0-5)

number

default:"0.5"

Interrupt sensitivity level (0-5)

integer

Minimum words before interruption is allowed (0-10). Set to enable.

Ambient Sound

string

Background ambient sound. Options: off, office, city, forest, crowded_room, cafe, nature

number

default:"0.5"

Ambient sound volume level (0-1)

Webhook Configuration

boolean

default:"false"

Whether webhook notifications are enabled

string

The webhook URL for post-call notifications. Required if is_webhook_active is true.

boolean

default:"true"

Whether to send webhooks only on completed calls (not failed/no-answer)

boolean

default:"true"

Whether to include recording URL in webhook payload

Post-Call Evaluation

boolean

default:"true"

Whether to enable AI post-call evaluation

array

Schema definition for post-call data extraction

Show post_call_schema properties

string

required

Field name (3-16 chars, lowercase, alphanumeric and underscores only)

string

required

Data type. Options: string, number, bool

string

required

Description of what this field represents (3-255 characters)

"post_call_schema": [
  {"name": "status", "type": "bool", "description": "Was the call objective achieved"},
  {"name": "summary", "type": "string", "description": "Brief summary of the call"}
]

Variables

object

Key-value pairs of custom variables accessible in prompts via {{variable_name}}

"variables": {
  "company_name": "Acme Corp",
  "product": "Premium Widget",
  "support_email": "support@acme.com"
}

Conversation Ended Settings

integer

default:"30"

Minutes of chat inactivity before the conversation is considered ended (1-1440)

boolean

default:"false"

Whether to allow re-triggering the conversation after it ends due to inactivity

string

Webhook URL called when a chat conversation ends due to inactivity. Separate from the main call webhook.

Example Requests

Pipeline Mode Assistant

{
  "name": "Sales Assistant",
  "voice_id": 1,
  "language_id": 1,
  "type": "outbound",
  "mode": "pipeline",
  "timezone": "Europe/Bucharest",
  "initial_message": "Hello! How can I help you today?",
  "system_prompt": "You are a professional sales assistant...",
  "llm_model_id": 2,
  "secondary_language_ids": [2, 3],
  "knowledgebase_id": 1,
  "knowledgebase_mode": "prompt",
  "fillers": true,
  "filler_config": {
    "positive": ["Great!", "Perfect!", "Awesome!"],
    "negative": ["Hmm.", "I see."],
    "question": ["Good question.", "Let me check."],
    "neutral": ["Ok.", "Noted.", "I understand."]
  },
  "tool_ids": [1, 5],
  "tools": [
    {
      "type": "end_call",
      "description": "End call when customer is satisfied"
    },
    {
      "type": "call_transfer",
      "phone_number": "+1234567890",
      "description": "Transfer to support"
    },
    {
      "type": "warm_call_transfer",
      "supervisor_phone": "+1234567891",
      "outbound_phone_id": 7,
      "description": "Transfer the call to a human supervisor when the customer requests to speak with a real person.",
      "custom_sip": false,
      "caller_id_mode": "outbound_number",
      "hold_music": "hold_music",
      "hold_music_volume": 80,
      "hold_message": "Please hold while I connect you with a supervisor.",
      "summary_instructions": "Introduce the conversation from your perspective:\n- WHO is calling (name, company if mentioned)\n- WHY they called (their goal or problem)\n- WHY a human is needed at this point\n\nKeep it brief (2-3 sentences).",
      "briefing_initial_message": "Hello! I have a caller on the line who needs your assistance. May I brief you on the situation?",
      "connected_message": "You are now connected with a supervisor. I'll leave you to it."
    },
    {
      "type": "collect_keypad",
      "timeout": 5,
      "stop_key": "#"
    }
  ],
  "reengagement_interval": 20,
  "reengagement_prompt": "Are you still there?"
}

Multimodal Mode Assistant

{
  "name": "Support Bot",
  "voice_id": 41,
  "language_id": 1,
  "type": "inbound",
  "mode": "multimodal",
  "timezone": "America/New_York",
  "initial_message": "Hi! Welcome to support.",
  "system_prompt": "You are a helpful support agent...",
  "multimodal_model_id": 1,
  "chat_llm_fallback_id": 2,
  "turn_detection_threshold": 0.7,
  "knowledgebase_id": 1,
  "knowledgebase_mode": "function_call",
  "tts_emotion_enabled": false
}

Dualplex Mode Assistant

{
  "name": "Premium Agent",
  "voice_id": 1,
  "language_id": 2,
  "type": "outbound",
  "mode": "dualplex",
  "timezone": "Europe/Bucharest",
  "initial_message": "Buna ziua!",
  "system_prompt": "Esti un asistent profesionist...",
  "multimodal_model_id": 4,
  "chat_llm_fallback_id": 2,
  "secondary_language_ids": [1, 3],
  "knowledgebase_id": 1,
  "knowledgebase_mode": "function_call",
  "ambient_sound": "office",
  "ambient_sound_volume": 0.3
}

Response

string

Success message confirming assistant creation

object

Show properties

integer

The unique identifier of the created assistant

string

The name of the assistant

string

The current status (inactive for new assistants)

string

The type (inbound or outbound)

string

The engine mode (pipeline, multimodal, or dualplex)

{
  "message": "Assistant created successfully",
  "data": {
    "id": 789,
    "name": "Sales Assistant",
    "status": "inactive",
    "type": "outbound",
    "mode": "pipeline"
  }
}

{
  "message": "Validation failed",
  "errors": {
    "name": ["The name field is required."],
    "voice_id": ["The selected voice is not compatible with the chosen engine type."],
    "knowledgebase_mode": ["Only function_call mode is available for multimodal assistants."]
  }
}

Notes

All required fields must be provided for successful assistant creation
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 is always enabled
Fillers are only available in pipeline mode
The assistant is created with inactive status by default

​Engine Modes

​Request Body

​Core Required Fields

​Mode-Specific Fields

​Secondary Languages

​Knowledgebase Settings

​Phone Number

​Custom Mid-Call Tools

​Built-in Tools

​Voice and TTS Settings

​Call Behavior Settings

​Timing Settings

​Re-engagement Settings

​Voicemail Settings

​Endpoint Detection

​Ambient Sound

​Webhook Configuration

​Post-Call Evaluation

​Variables

​Conversation Ended Settings

​Example Requests

​Pipeline Mode Assistant

​Multimodal Mode Assistant

​Dualplex Mode Assistant

​Response

​Notes

Engine Modes

Request Body

Core Required Fields

Mode-Specific Fields

Secondary Languages

Knowledgebase Settings

Phone Number

Custom Mid-Call Tools

Built-in Tools

Voice and TTS Settings

Call Behavior Settings

Timing Settings

Re-engagement Settings

Voicemail Settings

Endpoint Detection

Ambient Sound

Webhook Configuration

Post-Call Evaluation

Variables

Conversation Ended Settings

Example Requests

Pipeline Mode Assistant

Multimodal Mode Assistant

Dualplex Mode Assistant

Response

Notes