Update Assistant
curl --request PUT \
--url https://api.example.com/api/v1/assistants/{assistant_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"description": "<string>",
"llm_provider": "<string>",
"llm_provider_config": {
"api_key": "<string>",
"base_url": "<string>",
"model": "gpt-4o-mini",
"custom_config": {}
},
"openai_api_key": "<string>",
"custom_llm_url": "<string>",
"deepgram_api_key": "<string>",
"elevenlabs_api_key": "<string>",
"twilio_config": {
"account_sid": "<string>",
"auth_token": "<string>"
},
"twilio_account_sid": "<string>",
"twilio_auth_token": "<string>",
"llm_settings": {
"temperature": 0.5,
"max_tokens": 1000,
"system_prompt": "You are a helpful assistant that can answer questions and help with tasks.",
"welcome_message": "<string>",
"top_p": 1,
"frequency_penalty": 0,
"presence_penalty": 0,
"stop_sequences": [
"<string>"
]
},
"webhook_url": "<string>",
"interruption_settings": {
"interruption_threshold": 3,
"min_speaking_time": 0.5,
"interruption_cooldown": 2
},
"tts_settings": {
"provider": "elevenlabs",
"voice_id": "rachel",
"model_id": "turbo",
"latency": 1,
"stability": 0.5,
"similarity_boost": 0.75,
"style": 0,
"use_speaker_boost": true,
"provider_config": {}
},
"stt_settings": {
"model": "nova-2",
"language": "en-US",
"punctuate": true,
"interim_results": true,
"endpointing": {
"silence_threshold": 500,
"min_silence_duration": 500
},
"utterance_end_ms": 1000,
"vad_turnoff": 500,
"smart_format": true,
"keywords": [
{
"keyword": "<string>",
"intensifier": 1
}
],
"keyterms": [
"<string>"
],
"audio_denoising": false
},
"end_call_message": "<string>",
"transfer_call_message": "<string>",
"idle_message": "<string>",
"max_idle_messages": 123,
"idle_timeout": 123,
"tools_settings": {
"enabled_tools": [
"<string>"
],
"end_call": {
"enabled": false,
"scenarios": [
"<string>"
],
"custom_message": "<string>"
},
"transfer_call": {
"enabled": false,
"scenarios": [
"<string>"
],
"transfer_numbers": [
"<string>"
],
"custom_message": "<string>"
},
"custom_tools": [
{}
]
},
"rag_settings": {
"enabled": false,
"search_limit": 3,
"similarity_threshold": 0.7,
"embedding_model": "text-embedding-3-small",
"chunking_strategy": "recursive",
"chunk_size": 1000,
"chunk_overlap": 200,
"auto_process": true,
"include_metadata": true,
"context_window_tokens": 4000
},
"llm_fallback_providers": {
"enabled": false,
"fallbacks": [
{
"provider": "<string>",
"api_key": "<string>",
"base_url": "<string>",
"model": "<string>"
}
]
},
"custom_settings": {},
"is_active": true
}
'import requests
url = "https://api.example.com/api/v1/assistants/{assistant_id}"
payload = {
"name": "<string>",
"description": "<string>",
"llm_provider": "<string>",
"llm_provider_config": {
"api_key": "<string>",
"base_url": "<string>",
"model": "gpt-4o-mini",
"custom_config": {}
},
"openai_api_key": "<string>",
"custom_llm_url": "<string>",
"deepgram_api_key": "<string>",
"elevenlabs_api_key": "<string>",
"twilio_config": {
"account_sid": "<string>",
"auth_token": "<string>"
},
"twilio_account_sid": "<string>",
"twilio_auth_token": "<string>",
"llm_settings": {
"temperature": 0.5,
"max_tokens": 1000,
"system_prompt": "You are a helpful assistant that can answer questions and help with tasks.",
"welcome_message": "<string>",
"top_p": 1,
"frequency_penalty": 0,
"presence_penalty": 0,
"stop_sequences": ["<string>"]
},
"webhook_url": "<string>",
"interruption_settings": {
"interruption_threshold": 3,
"min_speaking_time": 0.5,
"interruption_cooldown": 2
},
"tts_settings": {
"provider": "elevenlabs",
"voice_id": "rachel",
"model_id": "turbo",
"latency": 1,
"stability": 0.5,
"similarity_boost": 0.75,
"style": 0,
"use_speaker_boost": True,
"provider_config": {}
},
"stt_settings": {
"model": "nova-2",
"language": "en-US",
"punctuate": True,
"interim_results": True,
"endpointing": {
"silence_threshold": 500,
"min_silence_duration": 500
},
"utterance_end_ms": 1000,
"vad_turnoff": 500,
"smart_format": True,
"keywords": [
{
"keyword": "<string>",
"intensifier": 1
}
],
"keyterms": ["<string>"],
"audio_denoising": False
},
"end_call_message": "<string>",
"transfer_call_message": "<string>",
"idle_message": "<string>",
"max_idle_messages": 123,
"idle_timeout": 123,
"tools_settings": {
"enabled_tools": ["<string>"],
"end_call": {
"enabled": False,
"scenarios": ["<string>"],
"custom_message": "<string>"
},
"transfer_call": {
"enabled": False,
"scenarios": ["<string>"],
"transfer_numbers": ["<string>"],
"custom_message": "<string>"
},
"custom_tools": [{}]
},
"rag_settings": {
"enabled": False,
"search_limit": 3,
"similarity_threshold": 0.7,
"embedding_model": "text-embedding-3-small",
"chunking_strategy": "recursive",
"chunk_size": 1000,
"chunk_overlap": 200,
"auto_process": True,
"include_metadata": True,
"context_window_tokens": 4000
},
"llm_fallback_providers": {
"enabled": False,
"fallbacks": [
{
"provider": "<string>",
"api_key": "<string>",
"base_url": "<string>",
"model": "<string>"
}
]
},
"custom_settings": {},
"is_active": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
description: '<string>',
llm_provider: '<string>',
llm_provider_config: {
api_key: '<string>',
base_url: '<string>',
model: 'gpt-4o-mini',
custom_config: {}
},
openai_api_key: '<string>',
custom_llm_url: '<string>',
deepgram_api_key: '<string>',
elevenlabs_api_key: '<string>',
twilio_config: {account_sid: '<string>', auth_token: '<string>'},
twilio_account_sid: '<string>',
twilio_auth_token: '<string>',
llm_settings: {
temperature: 0.5,
max_tokens: 1000,
system_prompt: 'You are a helpful assistant that can answer questions and help with tasks.',
welcome_message: '<string>',
top_p: 1,
frequency_penalty: 0,
presence_penalty: 0,
stop_sequences: ['<string>']
},
webhook_url: '<string>',
interruption_settings: {interruption_threshold: 3, min_speaking_time: 0.5, interruption_cooldown: 2},
tts_settings: {
provider: 'elevenlabs',
voice_id: 'rachel',
model_id: 'turbo',
latency: 1,
stability: 0.5,
similarity_boost: 0.75,
style: 0,
use_speaker_boost: true,
provider_config: {}
},
stt_settings: {
model: 'nova-2',
language: 'en-US',
punctuate: true,
interim_results: true,
endpointing: {silence_threshold: 500, min_silence_duration: 500},
utterance_end_ms: 1000,
vad_turnoff: 500,
smart_format: true,
keywords: [{keyword: '<string>', intensifier: 1}],
keyterms: ['<string>'],
audio_denoising: false
},
end_call_message: '<string>',
transfer_call_message: '<string>',
idle_message: '<string>',
max_idle_messages: 123,
idle_timeout: 123,
tools_settings: {
enabled_tools: ['<string>'],
end_call: {enabled: false, scenarios: ['<string>'], custom_message: '<string>'},
transfer_call: {
enabled: false,
scenarios: ['<string>'],
transfer_numbers: ['<string>'],
custom_message: '<string>'
},
custom_tools: [{}]
},
rag_settings: {
enabled: false,
search_limit: 3,
similarity_threshold: 0.7,
embedding_model: 'text-embedding-3-small',
chunking_strategy: 'recursive',
chunk_size: 1000,
chunk_overlap: 200,
auto_process: true,
include_metadata: true,
context_window_tokens: 4000
},
llm_fallback_providers: {
enabled: false,
fallbacks: [
{
provider: '<string>',
api_key: '<string>',
base_url: '<string>',
model: '<string>'
}
]
},
custom_settings: {},
is_active: true
})
};
fetch('https://api.example.com/api/v1/assistants/{assistant_id}', 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/api/v1/assistants/{assistant_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'description' => '<string>',
'llm_provider' => '<string>',
'llm_provider_config' => [
'api_key' => '<string>',
'base_url' => '<string>',
'model' => 'gpt-4o-mini',
'custom_config' => [
]
],
'openai_api_key' => '<string>',
'custom_llm_url' => '<string>',
'deepgram_api_key' => '<string>',
'elevenlabs_api_key' => '<string>',
'twilio_config' => [
'account_sid' => '<string>',
'auth_token' => '<string>'
],
'twilio_account_sid' => '<string>',
'twilio_auth_token' => '<string>',
'llm_settings' => [
'temperature' => 0.5,
'max_tokens' => 1000,
'system_prompt' => 'You are a helpful assistant that can answer questions and help with tasks.',
'welcome_message' => '<string>',
'top_p' => 1,
'frequency_penalty' => 0,
'presence_penalty' => 0,
'stop_sequences' => [
'<string>'
]
],
'webhook_url' => '<string>',
'interruption_settings' => [
'interruption_threshold' => 3,
'min_speaking_time' => 0.5,
'interruption_cooldown' => 2
],
'tts_settings' => [
'provider' => 'elevenlabs',
'voice_id' => 'rachel',
'model_id' => 'turbo',
'latency' => 1,
'stability' => 0.5,
'similarity_boost' => 0.75,
'style' => 0,
'use_speaker_boost' => true,
'provider_config' => [
]
],
'stt_settings' => [
'model' => 'nova-2',
'language' => 'en-US',
'punctuate' => true,
'interim_results' => true,
'endpointing' => [
'silence_threshold' => 500,
'min_silence_duration' => 500
],
'utterance_end_ms' => 1000,
'vad_turnoff' => 500,
'smart_format' => true,
'keywords' => [
[
'keyword' => '<string>',
'intensifier' => 1
]
],
'keyterms' => [
'<string>'
],
'audio_denoising' => false
],
'end_call_message' => '<string>',
'transfer_call_message' => '<string>',
'idle_message' => '<string>',
'max_idle_messages' => 123,
'idle_timeout' => 123,
'tools_settings' => [
'enabled_tools' => [
'<string>'
],
'end_call' => [
'enabled' => false,
'scenarios' => [
'<string>'
],
'custom_message' => '<string>'
],
'transfer_call' => [
'enabled' => false,
'scenarios' => [
'<string>'
],
'transfer_numbers' => [
'<string>'
],
'custom_message' => '<string>'
],
'custom_tools' => [
[
]
]
],
'rag_settings' => [
'enabled' => false,
'search_limit' => 3,
'similarity_threshold' => 0.7,
'embedding_model' => 'text-embedding-3-small',
'chunking_strategy' => 'recursive',
'chunk_size' => 1000,
'chunk_overlap' => 200,
'auto_process' => true,
'include_metadata' => true,
'context_window_tokens' => 4000
],
'llm_fallback_providers' => [
'enabled' => false,
'fallbacks' => [
[
'provider' => '<string>',
'api_key' => '<string>',
'base_url' => '<string>',
'model' => '<string>'
]
]
],
'custom_settings' => [
],
'is_active' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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/api/v1/assistants/{assistant_id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"llm_provider\": \"<string>\",\n \"llm_provider_config\": {\n \"api_key\": \"<string>\",\n \"base_url\": \"<string>\",\n \"model\": \"gpt-4o-mini\",\n \"custom_config\": {}\n },\n \"openai_api_key\": \"<string>\",\n \"custom_llm_url\": \"<string>\",\n \"deepgram_api_key\": \"<string>\",\n \"elevenlabs_api_key\": \"<string>\",\n \"twilio_config\": {\n \"account_sid\": \"<string>\",\n \"auth_token\": \"<string>\"\n },\n \"twilio_account_sid\": \"<string>\",\n \"twilio_auth_token\": \"<string>\",\n \"llm_settings\": {\n \"temperature\": 0.5,\n \"max_tokens\": 1000,\n \"system_prompt\": \"You are a helpful assistant that can answer questions and help with tasks.\",\n \"welcome_message\": \"<string>\",\n \"top_p\": 1,\n \"frequency_penalty\": 0,\n \"presence_penalty\": 0,\n \"stop_sequences\": [\n \"<string>\"\n ]\n },\n \"webhook_url\": \"<string>\",\n \"interruption_settings\": {\n \"interruption_threshold\": 3,\n \"min_speaking_time\": 0.5,\n \"interruption_cooldown\": 2\n },\n \"tts_settings\": {\n \"provider\": \"elevenlabs\",\n \"voice_id\": \"rachel\",\n \"model_id\": \"turbo\",\n \"latency\": 1,\n \"stability\": 0.5,\n \"similarity_boost\": 0.75,\n \"style\": 0,\n \"use_speaker_boost\": true,\n \"provider_config\": {}\n },\n \"stt_settings\": {\n \"model\": \"nova-2\",\n \"language\": \"en-US\",\n \"punctuate\": true,\n \"interim_results\": true,\n \"endpointing\": {\n \"silence_threshold\": 500,\n \"min_silence_duration\": 500\n },\n \"utterance_end_ms\": 1000,\n \"vad_turnoff\": 500,\n \"smart_format\": true,\n \"keywords\": [\n {\n \"keyword\": \"<string>\",\n \"intensifier\": 1\n }\n ],\n \"keyterms\": [\n \"<string>\"\n ],\n \"audio_denoising\": false\n },\n \"end_call_message\": \"<string>\",\n \"transfer_call_message\": \"<string>\",\n \"idle_message\": \"<string>\",\n \"max_idle_messages\": 123,\n \"idle_timeout\": 123,\n \"tools_settings\": {\n \"enabled_tools\": [\n \"<string>\"\n ],\n \"end_call\": {\n \"enabled\": false,\n \"scenarios\": [\n \"<string>\"\n ],\n \"custom_message\": \"<string>\"\n },\n \"transfer_call\": {\n \"enabled\": false,\n \"scenarios\": [\n \"<string>\"\n ],\n \"transfer_numbers\": [\n \"<string>\"\n ],\n \"custom_message\": \"<string>\"\n },\n \"custom_tools\": [\n {}\n ]\n },\n \"rag_settings\": {\n \"enabled\": false,\n \"search_limit\": 3,\n \"similarity_threshold\": 0.7,\n \"embedding_model\": \"text-embedding-3-small\",\n \"chunking_strategy\": \"recursive\",\n \"chunk_size\": 1000,\n \"chunk_overlap\": 200,\n \"auto_process\": true,\n \"include_metadata\": true,\n \"context_window_tokens\": 4000\n },\n \"llm_fallback_providers\": {\n \"enabled\": false,\n \"fallbacks\": [\n {\n \"provider\": \"<string>\",\n \"api_key\": \"<string>\",\n \"base_url\": \"<string>\",\n \"model\": \"<string>\"\n }\n ]\n },\n \"custom_settings\": {},\n \"is_active\": true\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.put("https://api.example.com/api/v1/assistants/{assistant_id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"llm_provider\": \"<string>\",\n \"llm_provider_config\": {\n \"api_key\": \"<string>\",\n \"base_url\": \"<string>\",\n \"model\": \"gpt-4o-mini\",\n \"custom_config\": {}\n },\n \"openai_api_key\": \"<string>\",\n \"custom_llm_url\": \"<string>\",\n \"deepgram_api_key\": \"<string>\",\n \"elevenlabs_api_key\": \"<string>\",\n \"twilio_config\": {\n \"account_sid\": \"<string>\",\n \"auth_token\": \"<string>\"\n },\n \"twilio_account_sid\": \"<string>\",\n \"twilio_auth_token\": \"<string>\",\n \"llm_settings\": {\n \"temperature\": 0.5,\n \"max_tokens\": 1000,\n \"system_prompt\": \"You are a helpful assistant that can answer questions and help with tasks.\",\n \"welcome_message\": \"<string>\",\n \"top_p\": 1,\n \"frequency_penalty\": 0,\n \"presence_penalty\": 0,\n \"stop_sequences\": [\n \"<string>\"\n ]\n },\n \"webhook_url\": \"<string>\",\n \"interruption_settings\": {\n \"interruption_threshold\": 3,\n \"min_speaking_time\": 0.5,\n \"interruption_cooldown\": 2\n },\n \"tts_settings\": {\n \"provider\": \"elevenlabs\",\n \"voice_id\": \"rachel\",\n \"model_id\": \"turbo\",\n \"latency\": 1,\n \"stability\": 0.5,\n \"similarity_boost\": 0.75,\n \"style\": 0,\n \"use_speaker_boost\": true,\n \"provider_config\": {}\n },\n \"stt_settings\": {\n \"model\": \"nova-2\",\n \"language\": \"en-US\",\n \"punctuate\": true,\n \"interim_results\": true,\n \"endpointing\": {\n \"silence_threshold\": 500,\n \"min_silence_duration\": 500\n },\n \"utterance_end_ms\": 1000,\n \"vad_turnoff\": 500,\n \"smart_format\": true,\n \"keywords\": [\n {\n \"keyword\": \"<string>\",\n \"intensifier\": 1\n }\n ],\n \"keyterms\": [\n \"<string>\"\n ],\n \"audio_denoising\": false\n },\n \"end_call_message\": \"<string>\",\n \"transfer_call_message\": \"<string>\",\n \"idle_message\": \"<string>\",\n \"max_idle_messages\": 123,\n \"idle_timeout\": 123,\n \"tools_settings\": {\n \"enabled_tools\": [\n \"<string>\"\n ],\n \"end_call\": {\n \"enabled\": false,\n \"scenarios\": [\n \"<string>\"\n ],\n \"custom_message\": \"<string>\"\n },\n \"transfer_call\": {\n \"enabled\": false,\n \"scenarios\": [\n \"<string>\"\n ],\n \"transfer_numbers\": [\n \"<string>\"\n ],\n \"custom_message\": \"<string>\"\n },\n \"custom_tools\": [\n {}\n ]\n },\n \"rag_settings\": {\n \"enabled\": false,\n \"search_limit\": 3,\n \"similarity_threshold\": 0.7,\n \"embedding_model\": \"text-embedding-3-small\",\n \"chunking_strategy\": \"recursive\",\n \"chunk_size\": 1000,\n \"chunk_overlap\": 200,\n \"auto_process\": true,\n \"include_metadata\": true,\n \"context_window_tokens\": 4000\n },\n \"llm_fallback_providers\": {\n \"enabled\": false,\n \"fallbacks\": [\n {\n \"provider\": \"<string>\",\n \"api_key\": \"<string>\",\n \"base_url\": \"<string>\",\n \"model\": \"<string>\"\n }\n ]\n },\n \"custom_settings\": {},\n \"is_active\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/assistants/{assistant_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"llm_provider\": \"<string>\",\n \"llm_provider_config\": {\n \"api_key\": \"<string>\",\n \"base_url\": \"<string>\",\n \"model\": \"gpt-4o-mini\",\n \"custom_config\": {}\n },\n \"openai_api_key\": \"<string>\",\n \"custom_llm_url\": \"<string>\",\n \"deepgram_api_key\": \"<string>\",\n \"elevenlabs_api_key\": \"<string>\",\n \"twilio_config\": {\n \"account_sid\": \"<string>\",\n \"auth_token\": \"<string>\"\n },\n \"twilio_account_sid\": \"<string>\",\n \"twilio_auth_token\": \"<string>\",\n \"llm_settings\": {\n \"temperature\": 0.5,\n \"max_tokens\": 1000,\n \"system_prompt\": \"You are a helpful assistant that can answer questions and help with tasks.\",\n \"welcome_message\": \"<string>\",\n \"top_p\": 1,\n \"frequency_penalty\": 0,\n \"presence_penalty\": 0,\n \"stop_sequences\": [\n \"<string>\"\n ]\n },\n \"webhook_url\": \"<string>\",\n \"interruption_settings\": {\n \"interruption_threshold\": 3,\n \"min_speaking_time\": 0.5,\n \"interruption_cooldown\": 2\n },\n \"tts_settings\": {\n \"provider\": \"elevenlabs\",\n \"voice_id\": \"rachel\",\n \"model_id\": \"turbo\",\n \"latency\": 1,\n \"stability\": 0.5,\n \"similarity_boost\": 0.75,\n \"style\": 0,\n \"use_speaker_boost\": true,\n \"provider_config\": {}\n },\n \"stt_settings\": {\n \"model\": \"nova-2\",\n \"language\": \"en-US\",\n \"punctuate\": true,\n \"interim_results\": true,\n \"endpointing\": {\n \"silence_threshold\": 500,\n \"min_silence_duration\": 500\n },\n \"utterance_end_ms\": 1000,\n \"vad_turnoff\": 500,\n \"smart_format\": true,\n \"keywords\": [\n {\n \"keyword\": \"<string>\",\n \"intensifier\": 1\n }\n ],\n \"keyterms\": [\n \"<string>\"\n ],\n \"audio_denoising\": false\n },\n \"end_call_message\": \"<string>\",\n \"transfer_call_message\": \"<string>\",\n \"idle_message\": \"<string>\",\n \"max_idle_messages\": 123,\n \"idle_timeout\": 123,\n \"tools_settings\": {\n \"enabled_tools\": [\n \"<string>\"\n ],\n \"end_call\": {\n \"enabled\": false,\n \"scenarios\": [\n \"<string>\"\n ],\n \"custom_message\": \"<string>\"\n },\n \"transfer_call\": {\n \"enabled\": false,\n \"scenarios\": [\n \"<string>\"\n ],\n \"transfer_numbers\": [\n \"<string>\"\n ],\n \"custom_message\": \"<string>\"\n },\n \"custom_tools\": [\n {}\n ]\n },\n \"rag_settings\": {\n \"enabled\": false,\n \"search_limit\": 3,\n \"similarity_threshold\": 0.7,\n \"embedding_model\": \"text-embedding-3-small\",\n \"chunking_strategy\": \"recursive\",\n \"chunk_size\": 1000,\n \"chunk_overlap\": 200,\n \"auto_process\": true,\n \"include_metadata\": true,\n \"context_window_tokens\": 4000\n },\n \"llm_fallback_providers\": {\n \"enabled\": false,\n \"fallbacks\": [\n {\n \"provider\": \"<string>\",\n \"api_key\": \"<string>\",\n \"base_url\": \"<string>\",\n \"model\": \"<string>\"\n }\n ]\n },\n \"custom_settings\": {},\n \"is_active\": true\n}"
response = http.request(request)
puts response.read_body{
"name": "<string>",
"id": 123,
"organization_id": 123,
"user_id": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"description": "<string>",
"llm_provider": "openai",
"llm_provider_config": {
"api_key": "<string>",
"base_url": "<string>",
"model": "gpt-4o-mini",
"custom_config": {}
},
"twilio_config": {
"account_sid": "<string>",
"auth_token": "<string>"
},
"llm_settings": {
"temperature": 0.5,
"max_tokens": 1000,
"system_prompt": "You are a helpful assistant that can answer questions and help with tasks.",
"welcome_message": "<string>",
"top_p": 1,
"frequency_penalty": 0,
"presence_penalty": 0,
"stop_sequences": [
"<string>"
]
},
"webhook_url": "<string>",
"interruption_settings": {
"interruption_threshold": 3,
"min_speaking_time": 0.5,
"interruption_cooldown": 2
},
"tts_settings": {
"provider": "elevenlabs",
"voice_id": "rachel",
"model_id": "turbo",
"latency": 1,
"stability": 0.5,
"similarity_boost": 0.75,
"style": 0,
"use_speaker_boost": true,
"provider_config": {}
},
"stt_settings": {
"model": "nova-2",
"language": "en-US",
"punctuate": true,
"interim_results": true,
"endpointing": {
"silence_threshold": 500,
"min_silence_duration": 500
},
"utterance_end_ms": 1000,
"vad_turnoff": 500,
"smart_format": true,
"keywords": [
{
"keyword": "<string>",
"intensifier": 1
}
],
"keyterms": [
"<string>"
],
"audio_denoising": false
},
"end_call_message": "<string>",
"transfer_call_message": "<string>",
"idle_message": "Are you still there? I'm here to help if you need anything.",
"max_idle_messages": 123,
"idle_timeout": 123,
"tools_settings": {
"enabled_tools": [
"<string>"
],
"end_call": {
"enabled": false,
"scenarios": [
"<string>"
],
"custom_message": "<string>"
},
"transfer_call": {
"enabled": false,
"scenarios": [
"<string>"
],
"transfer_numbers": [
"<string>"
],
"custom_message": "<string>"
},
"custom_tools": [
{}
]
},
"rag_settings": {
"enabled": false,
"search_limit": 3,
"similarity_threshold": 0.7,
"embedding_model": "text-embedding-3-small",
"chunking_strategy": "recursive",
"chunk_size": 1000,
"chunk_overlap": 200,
"auto_process": true,
"include_metadata": true,
"context_window_tokens": 4000
},
"llm_fallback_providers": {
"enabled": false,
"fallbacks": [
{
"provider": "<string>",
"api_key": "<string>",
"base_url": "<string>",
"model": "<string>"
}
]
},
"custom_settings": {},
"is_active": true
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Assistants
Update Assistant
Update an assistant.
Updates the assistant configuration if it belongs to your organization. Only the fields provided in the request will be updated.
PUT
/
api
/
v1
/
assistants
/
{assistant_id}
Update Assistant
curl --request PUT \
--url https://api.example.com/api/v1/assistants/{assistant_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"description": "<string>",
"llm_provider": "<string>",
"llm_provider_config": {
"api_key": "<string>",
"base_url": "<string>",
"model": "gpt-4o-mini",
"custom_config": {}
},
"openai_api_key": "<string>",
"custom_llm_url": "<string>",
"deepgram_api_key": "<string>",
"elevenlabs_api_key": "<string>",
"twilio_config": {
"account_sid": "<string>",
"auth_token": "<string>"
},
"twilio_account_sid": "<string>",
"twilio_auth_token": "<string>",
"llm_settings": {
"temperature": 0.5,
"max_tokens": 1000,
"system_prompt": "You are a helpful assistant that can answer questions and help with tasks.",
"welcome_message": "<string>",
"top_p": 1,
"frequency_penalty": 0,
"presence_penalty": 0,
"stop_sequences": [
"<string>"
]
},
"webhook_url": "<string>",
"interruption_settings": {
"interruption_threshold": 3,
"min_speaking_time": 0.5,
"interruption_cooldown": 2
},
"tts_settings": {
"provider": "elevenlabs",
"voice_id": "rachel",
"model_id": "turbo",
"latency": 1,
"stability": 0.5,
"similarity_boost": 0.75,
"style": 0,
"use_speaker_boost": true,
"provider_config": {}
},
"stt_settings": {
"model": "nova-2",
"language": "en-US",
"punctuate": true,
"interim_results": true,
"endpointing": {
"silence_threshold": 500,
"min_silence_duration": 500
},
"utterance_end_ms": 1000,
"vad_turnoff": 500,
"smart_format": true,
"keywords": [
{
"keyword": "<string>",
"intensifier": 1
}
],
"keyterms": [
"<string>"
],
"audio_denoising": false
},
"end_call_message": "<string>",
"transfer_call_message": "<string>",
"idle_message": "<string>",
"max_idle_messages": 123,
"idle_timeout": 123,
"tools_settings": {
"enabled_tools": [
"<string>"
],
"end_call": {
"enabled": false,
"scenarios": [
"<string>"
],
"custom_message": "<string>"
},
"transfer_call": {
"enabled": false,
"scenarios": [
"<string>"
],
"transfer_numbers": [
"<string>"
],
"custom_message": "<string>"
},
"custom_tools": [
{}
]
},
"rag_settings": {
"enabled": false,
"search_limit": 3,
"similarity_threshold": 0.7,
"embedding_model": "text-embedding-3-small",
"chunking_strategy": "recursive",
"chunk_size": 1000,
"chunk_overlap": 200,
"auto_process": true,
"include_metadata": true,
"context_window_tokens": 4000
},
"llm_fallback_providers": {
"enabled": false,
"fallbacks": [
{
"provider": "<string>",
"api_key": "<string>",
"base_url": "<string>",
"model": "<string>"
}
]
},
"custom_settings": {},
"is_active": true
}
'import requests
url = "https://api.example.com/api/v1/assistants/{assistant_id}"
payload = {
"name": "<string>",
"description": "<string>",
"llm_provider": "<string>",
"llm_provider_config": {
"api_key": "<string>",
"base_url": "<string>",
"model": "gpt-4o-mini",
"custom_config": {}
},
"openai_api_key": "<string>",
"custom_llm_url": "<string>",
"deepgram_api_key": "<string>",
"elevenlabs_api_key": "<string>",
"twilio_config": {
"account_sid": "<string>",
"auth_token": "<string>"
},
"twilio_account_sid": "<string>",
"twilio_auth_token": "<string>",
"llm_settings": {
"temperature": 0.5,
"max_tokens": 1000,
"system_prompt": "You are a helpful assistant that can answer questions and help with tasks.",
"welcome_message": "<string>",
"top_p": 1,
"frequency_penalty": 0,
"presence_penalty": 0,
"stop_sequences": ["<string>"]
},
"webhook_url": "<string>",
"interruption_settings": {
"interruption_threshold": 3,
"min_speaking_time": 0.5,
"interruption_cooldown": 2
},
"tts_settings": {
"provider": "elevenlabs",
"voice_id": "rachel",
"model_id": "turbo",
"latency": 1,
"stability": 0.5,
"similarity_boost": 0.75,
"style": 0,
"use_speaker_boost": True,
"provider_config": {}
},
"stt_settings": {
"model": "nova-2",
"language": "en-US",
"punctuate": True,
"interim_results": True,
"endpointing": {
"silence_threshold": 500,
"min_silence_duration": 500
},
"utterance_end_ms": 1000,
"vad_turnoff": 500,
"smart_format": True,
"keywords": [
{
"keyword": "<string>",
"intensifier": 1
}
],
"keyterms": ["<string>"],
"audio_denoising": False
},
"end_call_message": "<string>",
"transfer_call_message": "<string>",
"idle_message": "<string>",
"max_idle_messages": 123,
"idle_timeout": 123,
"tools_settings": {
"enabled_tools": ["<string>"],
"end_call": {
"enabled": False,
"scenarios": ["<string>"],
"custom_message": "<string>"
},
"transfer_call": {
"enabled": False,
"scenarios": ["<string>"],
"transfer_numbers": ["<string>"],
"custom_message": "<string>"
},
"custom_tools": [{}]
},
"rag_settings": {
"enabled": False,
"search_limit": 3,
"similarity_threshold": 0.7,
"embedding_model": "text-embedding-3-small",
"chunking_strategy": "recursive",
"chunk_size": 1000,
"chunk_overlap": 200,
"auto_process": True,
"include_metadata": True,
"context_window_tokens": 4000
},
"llm_fallback_providers": {
"enabled": False,
"fallbacks": [
{
"provider": "<string>",
"api_key": "<string>",
"base_url": "<string>",
"model": "<string>"
}
]
},
"custom_settings": {},
"is_active": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
description: '<string>',
llm_provider: '<string>',
llm_provider_config: {
api_key: '<string>',
base_url: '<string>',
model: 'gpt-4o-mini',
custom_config: {}
},
openai_api_key: '<string>',
custom_llm_url: '<string>',
deepgram_api_key: '<string>',
elevenlabs_api_key: '<string>',
twilio_config: {account_sid: '<string>', auth_token: '<string>'},
twilio_account_sid: '<string>',
twilio_auth_token: '<string>',
llm_settings: {
temperature: 0.5,
max_tokens: 1000,
system_prompt: 'You are a helpful assistant that can answer questions and help with tasks.',
welcome_message: '<string>',
top_p: 1,
frequency_penalty: 0,
presence_penalty: 0,
stop_sequences: ['<string>']
},
webhook_url: '<string>',
interruption_settings: {interruption_threshold: 3, min_speaking_time: 0.5, interruption_cooldown: 2},
tts_settings: {
provider: 'elevenlabs',
voice_id: 'rachel',
model_id: 'turbo',
latency: 1,
stability: 0.5,
similarity_boost: 0.75,
style: 0,
use_speaker_boost: true,
provider_config: {}
},
stt_settings: {
model: 'nova-2',
language: 'en-US',
punctuate: true,
interim_results: true,
endpointing: {silence_threshold: 500, min_silence_duration: 500},
utterance_end_ms: 1000,
vad_turnoff: 500,
smart_format: true,
keywords: [{keyword: '<string>', intensifier: 1}],
keyterms: ['<string>'],
audio_denoising: false
},
end_call_message: '<string>',
transfer_call_message: '<string>',
idle_message: '<string>',
max_idle_messages: 123,
idle_timeout: 123,
tools_settings: {
enabled_tools: ['<string>'],
end_call: {enabled: false, scenarios: ['<string>'], custom_message: '<string>'},
transfer_call: {
enabled: false,
scenarios: ['<string>'],
transfer_numbers: ['<string>'],
custom_message: '<string>'
},
custom_tools: [{}]
},
rag_settings: {
enabled: false,
search_limit: 3,
similarity_threshold: 0.7,
embedding_model: 'text-embedding-3-small',
chunking_strategy: 'recursive',
chunk_size: 1000,
chunk_overlap: 200,
auto_process: true,
include_metadata: true,
context_window_tokens: 4000
},
llm_fallback_providers: {
enabled: false,
fallbacks: [
{
provider: '<string>',
api_key: '<string>',
base_url: '<string>',
model: '<string>'
}
]
},
custom_settings: {},
is_active: true
})
};
fetch('https://api.example.com/api/v1/assistants/{assistant_id}', 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/api/v1/assistants/{assistant_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'description' => '<string>',
'llm_provider' => '<string>',
'llm_provider_config' => [
'api_key' => '<string>',
'base_url' => '<string>',
'model' => 'gpt-4o-mini',
'custom_config' => [
]
],
'openai_api_key' => '<string>',
'custom_llm_url' => '<string>',
'deepgram_api_key' => '<string>',
'elevenlabs_api_key' => '<string>',
'twilio_config' => [
'account_sid' => '<string>',
'auth_token' => '<string>'
],
'twilio_account_sid' => '<string>',
'twilio_auth_token' => '<string>',
'llm_settings' => [
'temperature' => 0.5,
'max_tokens' => 1000,
'system_prompt' => 'You are a helpful assistant that can answer questions and help with tasks.',
'welcome_message' => '<string>',
'top_p' => 1,
'frequency_penalty' => 0,
'presence_penalty' => 0,
'stop_sequences' => [
'<string>'
]
],
'webhook_url' => '<string>',
'interruption_settings' => [
'interruption_threshold' => 3,
'min_speaking_time' => 0.5,
'interruption_cooldown' => 2
],
'tts_settings' => [
'provider' => 'elevenlabs',
'voice_id' => 'rachel',
'model_id' => 'turbo',
'latency' => 1,
'stability' => 0.5,
'similarity_boost' => 0.75,
'style' => 0,
'use_speaker_boost' => true,
'provider_config' => [
]
],
'stt_settings' => [
'model' => 'nova-2',
'language' => 'en-US',
'punctuate' => true,
'interim_results' => true,
'endpointing' => [
'silence_threshold' => 500,
'min_silence_duration' => 500
],
'utterance_end_ms' => 1000,
'vad_turnoff' => 500,
'smart_format' => true,
'keywords' => [
[
'keyword' => '<string>',
'intensifier' => 1
]
],
'keyterms' => [
'<string>'
],
'audio_denoising' => false
],
'end_call_message' => '<string>',
'transfer_call_message' => '<string>',
'idle_message' => '<string>',
'max_idle_messages' => 123,
'idle_timeout' => 123,
'tools_settings' => [
'enabled_tools' => [
'<string>'
],
'end_call' => [
'enabled' => false,
'scenarios' => [
'<string>'
],
'custom_message' => '<string>'
],
'transfer_call' => [
'enabled' => false,
'scenarios' => [
'<string>'
],
'transfer_numbers' => [
'<string>'
],
'custom_message' => '<string>'
],
'custom_tools' => [
[
]
]
],
'rag_settings' => [
'enabled' => false,
'search_limit' => 3,
'similarity_threshold' => 0.7,
'embedding_model' => 'text-embedding-3-small',
'chunking_strategy' => 'recursive',
'chunk_size' => 1000,
'chunk_overlap' => 200,
'auto_process' => true,
'include_metadata' => true,
'context_window_tokens' => 4000
],
'llm_fallback_providers' => [
'enabled' => false,
'fallbacks' => [
[
'provider' => '<string>',
'api_key' => '<string>',
'base_url' => '<string>',
'model' => '<string>'
]
]
],
'custom_settings' => [
],
'is_active' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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/api/v1/assistants/{assistant_id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"llm_provider\": \"<string>\",\n \"llm_provider_config\": {\n \"api_key\": \"<string>\",\n \"base_url\": \"<string>\",\n \"model\": \"gpt-4o-mini\",\n \"custom_config\": {}\n },\n \"openai_api_key\": \"<string>\",\n \"custom_llm_url\": \"<string>\",\n \"deepgram_api_key\": \"<string>\",\n \"elevenlabs_api_key\": \"<string>\",\n \"twilio_config\": {\n \"account_sid\": \"<string>\",\n \"auth_token\": \"<string>\"\n },\n \"twilio_account_sid\": \"<string>\",\n \"twilio_auth_token\": \"<string>\",\n \"llm_settings\": {\n \"temperature\": 0.5,\n \"max_tokens\": 1000,\n \"system_prompt\": \"You are a helpful assistant that can answer questions and help with tasks.\",\n \"welcome_message\": \"<string>\",\n \"top_p\": 1,\n \"frequency_penalty\": 0,\n \"presence_penalty\": 0,\n \"stop_sequences\": [\n \"<string>\"\n ]\n },\n \"webhook_url\": \"<string>\",\n \"interruption_settings\": {\n \"interruption_threshold\": 3,\n \"min_speaking_time\": 0.5,\n \"interruption_cooldown\": 2\n },\n \"tts_settings\": {\n \"provider\": \"elevenlabs\",\n \"voice_id\": \"rachel\",\n \"model_id\": \"turbo\",\n \"latency\": 1,\n \"stability\": 0.5,\n \"similarity_boost\": 0.75,\n \"style\": 0,\n \"use_speaker_boost\": true,\n \"provider_config\": {}\n },\n \"stt_settings\": {\n \"model\": \"nova-2\",\n \"language\": \"en-US\",\n \"punctuate\": true,\n \"interim_results\": true,\n \"endpointing\": {\n \"silence_threshold\": 500,\n \"min_silence_duration\": 500\n },\n \"utterance_end_ms\": 1000,\n \"vad_turnoff\": 500,\n \"smart_format\": true,\n \"keywords\": [\n {\n \"keyword\": \"<string>\",\n \"intensifier\": 1\n }\n ],\n \"keyterms\": [\n \"<string>\"\n ],\n \"audio_denoising\": false\n },\n \"end_call_message\": \"<string>\",\n \"transfer_call_message\": \"<string>\",\n \"idle_message\": \"<string>\",\n \"max_idle_messages\": 123,\n \"idle_timeout\": 123,\n \"tools_settings\": {\n \"enabled_tools\": [\n \"<string>\"\n ],\n \"end_call\": {\n \"enabled\": false,\n \"scenarios\": [\n \"<string>\"\n ],\n \"custom_message\": \"<string>\"\n },\n \"transfer_call\": {\n \"enabled\": false,\n \"scenarios\": [\n \"<string>\"\n ],\n \"transfer_numbers\": [\n \"<string>\"\n ],\n \"custom_message\": \"<string>\"\n },\n \"custom_tools\": [\n {}\n ]\n },\n \"rag_settings\": {\n \"enabled\": false,\n \"search_limit\": 3,\n \"similarity_threshold\": 0.7,\n \"embedding_model\": \"text-embedding-3-small\",\n \"chunking_strategy\": \"recursive\",\n \"chunk_size\": 1000,\n \"chunk_overlap\": 200,\n \"auto_process\": true,\n \"include_metadata\": true,\n \"context_window_tokens\": 4000\n },\n \"llm_fallback_providers\": {\n \"enabled\": false,\n \"fallbacks\": [\n {\n \"provider\": \"<string>\",\n \"api_key\": \"<string>\",\n \"base_url\": \"<string>\",\n \"model\": \"<string>\"\n }\n ]\n },\n \"custom_settings\": {},\n \"is_active\": true\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.put("https://api.example.com/api/v1/assistants/{assistant_id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"llm_provider\": \"<string>\",\n \"llm_provider_config\": {\n \"api_key\": \"<string>\",\n \"base_url\": \"<string>\",\n \"model\": \"gpt-4o-mini\",\n \"custom_config\": {}\n },\n \"openai_api_key\": \"<string>\",\n \"custom_llm_url\": \"<string>\",\n \"deepgram_api_key\": \"<string>\",\n \"elevenlabs_api_key\": \"<string>\",\n \"twilio_config\": {\n \"account_sid\": \"<string>\",\n \"auth_token\": \"<string>\"\n },\n \"twilio_account_sid\": \"<string>\",\n \"twilio_auth_token\": \"<string>\",\n \"llm_settings\": {\n \"temperature\": 0.5,\n \"max_tokens\": 1000,\n \"system_prompt\": \"You are a helpful assistant that can answer questions and help with tasks.\",\n \"welcome_message\": \"<string>\",\n \"top_p\": 1,\n \"frequency_penalty\": 0,\n \"presence_penalty\": 0,\n \"stop_sequences\": [\n \"<string>\"\n ]\n },\n \"webhook_url\": \"<string>\",\n \"interruption_settings\": {\n \"interruption_threshold\": 3,\n \"min_speaking_time\": 0.5,\n \"interruption_cooldown\": 2\n },\n \"tts_settings\": {\n \"provider\": \"elevenlabs\",\n \"voice_id\": \"rachel\",\n \"model_id\": \"turbo\",\n \"latency\": 1,\n \"stability\": 0.5,\n \"similarity_boost\": 0.75,\n \"style\": 0,\n \"use_speaker_boost\": true,\n \"provider_config\": {}\n },\n \"stt_settings\": {\n \"model\": \"nova-2\",\n \"language\": \"en-US\",\n \"punctuate\": true,\n \"interim_results\": true,\n \"endpointing\": {\n \"silence_threshold\": 500,\n \"min_silence_duration\": 500\n },\n \"utterance_end_ms\": 1000,\n \"vad_turnoff\": 500,\n \"smart_format\": true,\n \"keywords\": [\n {\n \"keyword\": \"<string>\",\n \"intensifier\": 1\n }\n ],\n \"keyterms\": [\n \"<string>\"\n ],\n \"audio_denoising\": false\n },\n \"end_call_message\": \"<string>\",\n \"transfer_call_message\": \"<string>\",\n \"idle_message\": \"<string>\",\n \"max_idle_messages\": 123,\n \"idle_timeout\": 123,\n \"tools_settings\": {\n \"enabled_tools\": [\n \"<string>\"\n ],\n \"end_call\": {\n \"enabled\": false,\n \"scenarios\": [\n \"<string>\"\n ],\n \"custom_message\": \"<string>\"\n },\n \"transfer_call\": {\n \"enabled\": false,\n \"scenarios\": [\n \"<string>\"\n ],\n \"transfer_numbers\": [\n \"<string>\"\n ],\n \"custom_message\": \"<string>\"\n },\n \"custom_tools\": [\n {}\n ]\n },\n \"rag_settings\": {\n \"enabled\": false,\n \"search_limit\": 3,\n \"similarity_threshold\": 0.7,\n \"embedding_model\": \"text-embedding-3-small\",\n \"chunking_strategy\": \"recursive\",\n \"chunk_size\": 1000,\n \"chunk_overlap\": 200,\n \"auto_process\": true,\n \"include_metadata\": true,\n \"context_window_tokens\": 4000\n },\n \"llm_fallback_providers\": {\n \"enabled\": false,\n \"fallbacks\": [\n {\n \"provider\": \"<string>\",\n \"api_key\": \"<string>\",\n \"base_url\": \"<string>\",\n \"model\": \"<string>\"\n }\n ]\n },\n \"custom_settings\": {},\n \"is_active\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/assistants/{assistant_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"llm_provider\": \"<string>\",\n \"llm_provider_config\": {\n \"api_key\": \"<string>\",\n \"base_url\": \"<string>\",\n \"model\": \"gpt-4o-mini\",\n \"custom_config\": {}\n },\n \"openai_api_key\": \"<string>\",\n \"custom_llm_url\": \"<string>\",\n \"deepgram_api_key\": \"<string>\",\n \"elevenlabs_api_key\": \"<string>\",\n \"twilio_config\": {\n \"account_sid\": \"<string>\",\n \"auth_token\": \"<string>\"\n },\n \"twilio_account_sid\": \"<string>\",\n \"twilio_auth_token\": \"<string>\",\n \"llm_settings\": {\n \"temperature\": 0.5,\n \"max_tokens\": 1000,\n \"system_prompt\": \"You are a helpful assistant that can answer questions and help with tasks.\",\n \"welcome_message\": \"<string>\",\n \"top_p\": 1,\n \"frequency_penalty\": 0,\n \"presence_penalty\": 0,\n \"stop_sequences\": [\n \"<string>\"\n ]\n },\n \"webhook_url\": \"<string>\",\n \"interruption_settings\": {\n \"interruption_threshold\": 3,\n \"min_speaking_time\": 0.5,\n \"interruption_cooldown\": 2\n },\n \"tts_settings\": {\n \"provider\": \"elevenlabs\",\n \"voice_id\": \"rachel\",\n \"model_id\": \"turbo\",\n \"latency\": 1,\n \"stability\": 0.5,\n \"similarity_boost\": 0.75,\n \"style\": 0,\n \"use_speaker_boost\": true,\n \"provider_config\": {}\n },\n \"stt_settings\": {\n \"model\": \"nova-2\",\n \"language\": \"en-US\",\n \"punctuate\": true,\n \"interim_results\": true,\n \"endpointing\": {\n \"silence_threshold\": 500,\n \"min_silence_duration\": 500\n },\n \"utterance_end_ms\": 1000,\n \"vad_turnoff\": 500,\n \"smart_format\": true,\n \"keywords\": [\n {\n \"keyword\": \"<string>\",\n \"intensifier\": 1\n }\n ],\n \"keyterms\": [\n \"<string>\"\n ],\n \"audio_denoising\": false\n },\n \"end_call_message\": \"<string>\",\n \"transfer_call_message\": \"<string>\",\n \"idle_message\": \"<string>\",\n \"max_idle_messages\": 123,\n \"idle_timeout\": 123,\n \"tools_settings\": {\n \"enabled_tools\": [\n \"<string>\"\n ],\n \"end_call\": {\n \"enabled\": false,\n \"scenarios\": [\n \"<string>\"\n ],\n \"custom_message\": \"<string>\"\n },\n \"transfer_call\": {\n \"enabled\": false,\n \"scenarios\": [\n \"<string>\"\n ],\n \"transfer_numbers\": [\n \"<string>\"\n ],\n \"custom_message\": \"<string>\"\n },\n \"custom_tools\": [\n {}\n ]\n },\n \"rag_settings\": {\n \"enabled\": false,\n \"search_limit\": 3,\n \"similarity_threshold\": 0.7,\n \"embedding_model\": \"text-embedding-3-small\",\n \"chunking_strategy\": \"recursive\",\n \"chunk_size\": 1000,\n \"chunk_overlap\": 200,\n \"auto_process\": true,\n \"include_metadata\": true,\n \"context_window_tokens\": 4000\n },\n \"llm_fallback_providers\": {\n \"enabled\": false,\n \"fallbacks\": [\n {\n \"provider\": \"<string>\",\n \"api_key\": \"<string>\",\n \"base_url\": \"<string>\",\n \"model\": \"<string>\"\n }\n ]\n },\n \"custom_settings\": {},\n \"is_active\": true\n}"
response = http.request(request)
puts response.read_body{
"name": "<string>",
"id": 123,
"organization_id": 123,
"user_id": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"description": "<string>",
"llm_provider": "openai",
"llm_provider_config": {
"api_key": "<string>",
"base_url": "<string>",
"model": "gpt-4o-mini",
"custom_config": {}
},
"twilio_config": {
"account_sid": "<string>",
"auth_token": "<string>"
},
"llm_settings": {
"temperature": 0.5,
"max_tokens": 1000,
"system_prompt": "You are a helpful assistant that can answer questions and help with tasks.",
"welcome_message": "<string>",
"top_p": 1,
"frequency_penalty": 0,
"presence_penalty": 0,
"stop_sequences": [
"<string>"
]
},
"webhook_url": "<string>",
"interruption_settings": {
"interruption_threshold": 3,
"min_speaking_time": 0.5,
"interruption_cooldown": 2
},
"tts_settings": {
"provider": "elevenlabs",
"voice_id": "rachel",
"model_id": "turbo",
"latency": 1,
"stability": 0.5,
"similarity_boost": 0.75,
"style": 0,
"use_speaker_boost": true,
"provider_config": {}
},
"stt_settings": {
"model": "nova-2",
"language": "en-US",
"punctuate": true,
"interim_results": true,
"endpointing": {
"silence_threshold": 500,
"min_silence_duration": 500
},
"utterance_end_ms": 1000,
"vad_turnoff": 500,
"smart_format": true,
"keywords": [
{
"keyword": "<string>",
"intensifier": 1
}
],
"keyterms": [
"<string>"
],
"audio_denoising": false
},
"end_call_message": "<string>",
"transfer_call_message": "<string>",
"idle_message": "Are you still there? I'm here to help if you need anything.",
"max_idle_messages": 123,
"idle_timeout": 123,
"tools_settings": {
"enabled_tools": [
"<string>"
],
"end_call": {
"enabled": false,
"scenarios": [
"<string>"
],
"custom_message": "<string>"
},
"transfer_call": {
"enabled": false,
"scenarios": [
"<string>"
],
"transfer_numbers": [
"<string>"
],
"custom_message": "<string>"
},
"custom_tools": [
{}
]
},
"rag_settings": {
"enabled": false,
"search_limit": 3,
"similarity_threshold": 0.7,
"embedding_model": "text-embedding-3-small",
"chunking_strategy": "recursive",
"chunk_size": 1000,
"chunk_overlap": 200,
"auto_process": true,
"include_metadata": true,
"context_window_tokens": 4000
},
"llm_fallback_providers": {
"enabled": false,
"fallbacks": [
{
"provider": "<string>",
"api_key": "<string>",
"base_url": "<string>",
"model": "<string>"
}
]
},
"custom_settings": {},
"is_active": true
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}This endpoint allows you to modify the configuration of an existing assistant by providing its unique ID. You only need to include the fields you wish to update in the request body; any omitted fields will remain unchanged.
Path Parameters
assistant_id(string, required): The unique identifier of the assistant you want to update.
Request Body
The request body is a JSON object containing the fields to update. The structure and available parameters are identical to those used when creating an assistant. Refer to the Create Assistant documentation for a detailed breakdown of all possible fields within thellm_settings, tts_settings, stt_settings, interruption_settings, and tools_settings objects.
Below is an example of a request to change an assistant’s name and its LLM temperature.
Request
{
"name": "Senior Customer Support Specialist",
"llm_settings": {
"temperature": 0.5
}
}
Response
A successful update will return the complete, updated assistant object.Response
{
"id": "asst_a1b2c3d4e5f67890",
"user_id": "user_12345",
"organization_id": "org_67890",
"name": "Senior Customer Support Specialist",
"description": "Handles inbound customer queries and provides support.",
"is_active": true,
"llm_settings": {
"provider": "openai",
"model": "gpt-4-turbo",
"temperature": 0.5,
"max_tokens": 250
},
"tts_settings": {
"provider": "elevenlabs",
"voice_id": "EXAVITQu4vr4xnSDxMaL",
"stability": 0.5,
"similarity_boost": 0.75
},
"stt_settings": {
"provider": "deepgram",
"language": "en-US",
"model": "nova-2"
},
"interruption_settings": {
"enabled": true,
"threshold": 0.5,
"evaluation_period": 0.8
},
"tools_settings": {
"end_call": {
"enabled": true,
"scenarios": ["The user says goodbye.", "The issue is fully resolved."]
},
"transfer_call": {
"enabled": false
}
},
"created_at": "2023-10-26T10:00:00Z",
"updated_at": "2023-10-26T10:15:00Z"
}
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Body
application/json
Schema for updating an assistant.
Configuration for the LLM provider.
Show child attributes
Show child attributes
Twilio account configuration.
Show child attributes
Show child attributes
Settings for the Large Language Model.
Show child attributes
Show child attributes
Settings for call interruption behavior.
Show child attributes
Show child attributes
Settings for Text-to-Speech (TTS) service.
Show child attributes
Show child attributes
Settings for Speech-to-Text (STT) service.
Show child attributes
Show child attributes
Settings for integrated tools.
Show child attributes
Show child attributes
Settings for Retrieval-Augmented Generation (RAG).
Show child attributes
Show child attributes
Settings for LLM fallback providers.
Show child attributes
Show child attributes
Response
Successful Response
Schema for assistant response.
LLM provider: openai, anthropic, gemini, xai, groq, custom
Configuration for the selected LLM provider.
Show child attributes
Show child attributes
Twilio account configuration.
Show child attributes
Show child attributes
Settings for the Large Language Model.
Show child attributes
Show child attributes
Settings for call interruption behavior.
Show child attributes
Show child attributes
Settings for Text-to-Speech (TTS) service.
Show child attributes
Show child attributes
Settings for Speech-to-Text (STT) service.
Show child attributes
Show child attributes
Settings for integrated tools.
Show child attributes
Show child attributes
Settings for Retrieval-Augmented Generation (RAG).
Show child attributes
Show child attributes
Settings for LLM fallback providers.
Show child attributes
Show child attributes