Patch Agent
curl --request PATCH \
--url https://api.example.com/api/agents/{agent_id} \
--header 'Content-Type: application/json' \
--data '
{
"prompt": "<string>",
"agent_name": "<string>",
"agent_phone_number": "<string>",
"voice_id": "<string>",
"welcome_text": "<string>",
"enabled": true,
"tools": [
"<unknown>"
],
"save_stats": true,
"server_type": "DEV",
"provider_type": "EXOTEL",
"llm_config_json": {},
"audio_config_json": {},
"call_settings_json": {},
"analytics_config_json": {},
"tools_config_json": {},
"created_from_template_id": 123,
"created_from_template_version": 123
}
'import requests
url = "https://api.example.com/api/agents/{agent_id}"
payload = {
"prompt": "<string>",
"agent_name": "<string>",
"agent_phone_number": "<string>",
"voice_id": "<string>",
"welcome_text": "<string>",
"enabled": True,
"tools": ["<unknown>"],
"save_stats": True,
"server_type": "DEV",
"provider_type": "EXOTEL",
"llm_config_json": {},
"audio_config_json": {},
"call_settings_json": {},
"analytics_config_json": {},
"tools_config_json": {},
"created_from_template_id": 123,
"created_from_template_version": 123
}
headers = {"Content-Type": "application/json"}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
prompt: '<string>',
agent_name: '<string>',
agent_phone_number: '<string>',
voice_id: '<string>',
welcome_text: '<string>',
enabled: true,
tools: ['<unknown>'],
save_stats: true,
server_type: 'DEV',
provider_type: 'EXOTEL',
llm_config_json: {},
audio_config_json: {},
call_settings_json: {},
analytics_config_json: {},
tools_config_json: {},
created_from_template_id: 123,
created_from_template_version: 123
})
};
fetch('https://api.example.com/api/agents/{agent_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/agents/{agent_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'prompt' => '<string>',
'agent_name' => '<string>',
'agent_phone_number' => '<string>',
'voice_id' => '<string>',
'welcome_text' => '<string>',
'enabled' => true,
'tools' => [
'<unknown>'
],
'save_stats' => true,
'server_type' => 'DEV',
'provider_type' => 'EXOTEL',
'llm_config_json' => [
],
'audio_config_json' => [
],
'call_settings_json' => [
],
'analytics_config_json' => [
],
'tools_config_json' => [
],
'created_from_template_id' => 123,
'created_from_template_version' => 123
]),
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/api/agents/{agent_id}"
payload := strings.NewReader("{\n \"prompt\": \"<string>\",\n \"agent_name\": \"<string>\",\n \"agent_phone_number\": \"<string>\",\n \"voice_id\": \"<string>\",\n \"welcome_text\": \"<string>\",\n \"enabled\": true,\n \"tools\": [\n \"<unknown>\"\n ],\n \"save_stats\": true,\n \"server_type\": \"DEV\",\n \"provider_type\": \"EXOTEL\",\n \"llm_config_json\": {},\n \"audio_config_json\": {},\n \"call_settings_json\": {},\n \"analytics_config_json\": {},\n \"tools_config_json\": {},\n \"created_from_template_id\": 123,\n \"created_from_template_version\": 123\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api.example.com/api/agents/{agent_id}")
.header("Content-Type", "application/json")
.body("{\n \"prompt\": \"<string>\",\n \"agent_name\": \"<string>\",\n \"agent_phone_number\": \"<string>\",\n \"voice_id\": \"<string>\",\n \"welcome_text\": \"<string>\",\n \"enabled\": true,\n \"tools\": [\n \"<unknown>\"\n ],\n \"save_stats\": true,\n \"server_type\": \"DEV\",\n \"provider_type\": \"EXOTEL\",\n \"llm_config_json\": {},\n \"audio_config_json\": {},\n \"call_settings_json\": {},\n \"analytics_config_json\": {},\n \"tools_config_json\": {},\n \"created_from_template_id\": 123,\n \"created_from_template_version\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/agents/{agent_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"prompt\": \"<string>\",\n \"agent_name\": \"<string>\",\n \"agent_phone_number\": \"<string>\",\n \"voice_id\": \"<string>\",\n \"welcome_text\": \"<string>\",\n \"enabled\": true,\n \"tools\": [\n \"<unknown>\"\n ],\n \"save_stats\": true,\n \"server_type\": \"DEV\",\n \"provider_type\": \"EXOTEL\",\n \"llm_config_json\": {},\n \"audio_config_json\": {},\n \"call_settings_json\": {},\n \"analytics_config_json\": {},\n \"tools_config_json\": {},\n \"created_from_template_id\": 123,\n \"created_from_template_version\": 123\n}"
response = http.request(request)
puts response.read_body{
"id": 123,
"prompt": "<string>",
"agent_name": "<string>",
"agent_phone_number": "<string>",
"voice_id": "<string>",
"version": 123,
"welcome_text": "<string>",
"enabled": true,
"save_stats": true,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"tools": [
"<unknown>"
],
"provider_type": "EXOTEL",
"llm_config_json": {},
"audio_config_json": {},
"call_settings_json": {},
"tools_config_json": {},
"analytics_config_json": {},
"created_from_template_id": 123,
"created_from_template_version": 123
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}API Reference
Patch Agent
PATCH
/
api
/
agents
/
{agent_id}
Patch Agent
curl --request PATCH \
--url https://api.example.com/api/agents/{agent_id} \
--header 'Content-Type: application/json' \
--data '
{
"prompt": "<string>",
"agent_name": "<string>",
"agent_phone_number": "<string>",
"voice_id": "<string>",
"welcome_text": "<string>",
"enabled": true,
"tools": [
"<unknown>"
],
"save_stats": true,
"server_type": "DEV",
"provider_type": "EXOTEL",
"llm_config_json": {},
"audio_config_json": {},
"call_settings_json": {},
"analytics_config_json": {},
"tools_config_json": {},
"created_from_template_id": 123,
"created_from_template_version": 123
}
'import requests
url = "https://api.example.com/api/agents/{agent_id}"
payload = {
"prompt": "<string>",
"agent_name": "<string>",
"agent_phone_number": "<string>",
"voice_id": "<string>",
"welcome_text": "<string>",
"enabled": True,
"tools": ["<unknown>"],
"save_stats": True,
"server_type": "DEV",
"provider_type": "EXOTEL",
"llm_config_json": {},
"audio_config_json": {},
"call_settings_json": {},
"analytics_config_json": {},
"tools_config_json": {},
"created_from_template_id": 123,
"created_from_template_version": 123
}
headers = {"Content-Type": "application/json"}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
prompt: '<string>',
agent_name: '<string>',
agent_phone_number: '<string>',
voice_id: '<string>',
welcome_text: '<string>',
enabled: true,
tools: ['<unknown>'],
save_stats: true,
server_type: 'DEV',
provider_type: 'EXOTEL',
llm_config_json: {},
audio_config_json: {},
call_settings_json: {},
analytics_config_json: {},
tools_config_json: {},
created_from_template_id: 123,
created_from_template_version: 123
})
};
fetch('https://api.example.com/api/agents/{agent_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/agents/{agent_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'prompt' => '<string>',
'agent_name' => '<string>',
'agent_phone_number' => '<string>',
'voice_id' => '<string>',
'welcome_text' => '<string>',
'enabled' => true,
'tools' => [
'<unknown>'
],
'save_stats' => true,
'server_type' => 'DEV',
'provider_type' => 'EXOTEL',
'llm_config_json' => [
],
'audio_config_json' => [
],
'call_settings_json' => [
],
'analytics_config_json' => [
],
'tools_config_json' => [
],
'created_from_template_id' => 123,
'created_from_template_version' => 123
]),
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/api/agents/{agent_id}"
payload := strings.NewReader("{\n \"prompt\": \"<string>\",\n \"agent_name\": \"<string>\",\n \"agent_phone_number\": \"<string>\",\n \"voice_id\": \"<string>\",\n \"welcome_text\": \"<string>\",\n \"enabled\": true,\n \"tools\": [\n \"<unknown>\"\n ],\n \"save_stats\": true,\n \"server_type\": \"DEV\",\n \"provider_type\": \"EXOTEL\",\n \"llm_config_json\": {},\n \"audio_config_json\": {},\n \"call_settings_json\": {},\n \"analytics_config_json\": {},\n \"tools_config_json\": {},\n \"created_from_template_id\": 123,\n \"created_from_template_version\": 123\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api.example.com/api/agents/{agent_id}")
.header("Content-Type", "application/json")
.body("{\n \"prompt\": \"<string>\",\n \"agent_name\": \"<string>\",\n \"agent_phone_number\": \"<string>\",\n \"voice_id\": \"<string>\",\n \"welcome_text\": \"<string>\",\n \"enabled\": true,\n \"tools\": [\n \"<unknown>\"\n ],\n \"save_stats\": true,\n \"server_type\": \"DEV\",\n \"provider_type\": \"EXOTEL\",\n \"llm_config_json\": {},\n \"audio_config_json\": {},\n \"call_settings_json\": {},\n \"analytics_config_json\": {},\n \"tools_config_json\": {},\n \"created_from_template_id\": 123,\n \"created_from_template_version\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/agents/{agent_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"prompt\": \"<string>\",\n \"agent_name\": \"<string>\",\n \"agent_phone_number\": \"<string>\",\n \"voice_id\": \"<string>\",\n \"welcome_text\": \"<string>\",\n \"enabled\": true,\n \"tools\": [\n \"<unknown>\"\n ],\n \"save_stats\": true,\n \"server_type\": \"DEV\",\n \"provider_type\": \"EXOTEL\",\n \"llm_config_json\": {},\n \"audio_config_json\": {},\n \"call_settings_json\": {},\n \"analytics_config_json\": {},\n \"tools_config_json\": {},\n \"created_from_template_id\": 123,\n \"created_from_template_version\": 123\n}"
response = http.request(request)
puts response.read_body{
"id": 123,
"prompt": "<string>",
"agent_name": "<string>",
"agent_phone_number": "<string>",
"voice_id": "<string>",
"version": 123,
"welcome_text": "<string>",
"enabled": true,
"save_stats": true,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"tools": [
"<unknown>"
],
"provider_type": "EXOTEL",
"llm_config_json": {},
"audio_config_json": {},
"call_settings_json": {},
"tools_config_json": {},
"analytics_config_json": {},
"created_from_template_id": 123,
"created_from_template_version": 123
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Path Parameters
Body
application/json
Available options:
LOCAL, DEV, QA, PROD Available options:
INCOMING, OUTGOING Telephony provider types for call agents.
Available options:
EXOTEL, PLIVO_CX, PLIVO_L Response
Successful Response
Available options:
LOCAL, DEV, QA, PROD Available options:
INCOMING, OUTGOING Telephony provider types for call agents.
Available options:
EXOTEL, PLIVO_CX, PLIVO_L ⌘I