Update Agent
curl --request PATCH \
--url https://api.sigmamind.ai/v1/agents/{agentId} \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"agentName": "Auralis",
"instructions": "You are a helpful customer support assistant. Answer concisely and professionally.",
"welcomeMessageType": "static",
"welcomeMessage": "Welcome to our service! How can I assist you today?",
"agentSettings": {
"language": "en_US",
"aiStartsConversation": true,
"backgroundSound": "keyboard_typing",
"globalPrompt": "You are a professional virtual assistant. Always respond politely and keep answers concise.",
"remindersIntervalDuration": 15,
"remindersLimit": 3,
"endCallOnSilenceDuration": 30,
"maxCallDuration": 40,
"llmModel": "gpt-4o-mini",
"llmTemperature": 0.5,
"llmTopP": 0.5,
"llmTopK": 40,
"voiceId": "elevenlabs_SGbOfpm28edC83pZ9iGb",
"voiceModelId": "eleven_turbo_v2_5",
"ttsSpeed": 0.7,
"ttsTemperature": 0.5,
"ttsVolume": 0.5,
"aiStartsSpeakingPlan": 0.5,
"aiStopsSpeakingPlan": 0.5,
"ivrHangup": true,
"agentTimezone": "Asia/Kolkata",
"autoVolumeNormalization": true,
"backgroundNoiseFilter": true,
"echoCancellation": true,
"enablePostConversationAnalysis": true,
"postConversationAnalysisLlmModel": "gpt-4o-mini",
"postConversationAnalysis": [
{
"insightName": "conversation summary",
"insightInstructions": "<string>",
"dataType": "string",
"options": [
"Interested",
"Not Interested",
"Follow Up Later"
]
}
],
"webhooks": [
{
"name": "Call Events - Production",
"url": "https://yourapp.com/webhooks/sigmamind",
"events": [
"conversation_started",
"conversation_ended"
],
"webhookId": "wh_BUbkx3PsbzQm5V10"
}
]
},
"tools": [
{
"type": "voice_transfer_call",
"transferTo": "+9187788XXXXX",
"instruction": "<string>",
"transferToRouting": "static",
"extensionNumber": "1234",
"nodeId": "<string>",
"toolName": "<string>"
}
]
}
'import requests
url = "https://api.sigmamind.ai/v1/agents/{agentId}"
payload = {
"agentName": "Auralis",
"instructions": "You are a helpful customer support assistant. Answer concisely and professionally.",
"welcomeMessageType": "static",
"welcomeMessage": "Welcome to our service! How can I assist you today?",
"agentSettings": {
"language": "en_US",
"aiStartsConversation": True,
"backgroundSound": "keyboard_typing",
"globalPrompt": "You are a professional virtual assistant. Always respond politely and keep answers concise.",
"remindersIntervalDuration": 15,
"remindersLimit": 3,
"endCallOnSilenceDuration": 30,
"maxCallDuration": 40,
"llmModel": "gpt-4o-mini",
"llmTemperature": 0.5,
"llmTopP": 0.5,
"llmTopK": 40,
"voiceId": "elevenlabs_SGbOfpm28edC83pZ9iGb",
"voiceModelId": "eleven_turbo_v2_5",
"ttsSpeed": 0.7,
"ttsTemperature": 0.5,
"ttsVolume": 0.5,
"aiStartsSpeakingPlan": 0.5,
"aiStopsSpeakingPlan": 0.5,
"ivrHangup": True,
"agentTimezone": "Asia/Kolkata",
"autoVolumeNormalization": True,
"backgroundNoiseFilter": True,
"echoCancellation": True,
"enablePostConversationAnalysis": True,
"postConversationAnalysisLlmModel": "gpt-4o-mini",
"postConversationAnalysis": [
{
"insightName": "conversation summary",
"insightInstructions": "<string>",
"dataType": "string",
"options": ["Interested", "Not Interested", "Follow Up Later"]
}
],
"webhooks": [
{
"name": "Call Events - Production",
"url": "https://yourapp.com/webhooks/sigmamind",
"events": ["conversation_started", "conversation_ended"],
"webhookId": "wh_BUbkx3PsbzQm5V10"
}
]
},
"tools": [
{
"type": "voice_transfer_call",
"transferTo": "+9187788XXXXX",
"instruction": "<string>",
"transferToRouting": "static",
"extensionNumber": "1234",
"nodeId": "<string>",
"toolName": "<string>"
}
]
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
agentName: 'Auralis',
instructions: 'You are a helpful customer support assistant. Answer concisely and professionally.',
welcomeMessageType: 'static',
welcomeMessage: 'Welcome to our service! How can I assist you today?',
agentSettings: {
language: 'en_US',
aiStartsConversation: true,
backgroundSound: 'keyboard_typing',
globalPrompt: 'You are a professional virtual assistant. Always respond politely and keep answers concise.',
remindersIntervalDuration: 15,
remindersLimit: 3,
endCallOnSilenceDuration: 30,
maxCallDuration: 40,
llmModel: 'gpt-4o-mini',
llmTemperature: 0.5,
llmTopP: 0.5,
llmTopK: 40,
voiceId: 'elevenlabs_SGbOfpm28edC83pZ9iGb',
voiceModelId: 'eleven_turbo_v2_5',
ttsSpeed: 0.7,
ttsTemperature: 0.5,
ttsVolume: 0.5,
aiStartsSpeakingPlan: 0.5,
aiStopsSpeakingPlan: 0.5,
ivrHangup: true,
agentTimezone: 'Asia/Kolkata',
autoVolumeNormalization: true,
backgroundNoiseFilter: true,
echoCancellation: true,
enablePostConversationAnalysis: true,
postConversationAnalysisLlmModel: 'gpt-4o-mini',
postConversationAnalysis: [
{
insightName: 'conversation summary',
insightInstructions: '<string>',
dataType: 'string',
options: ['Interested', 'Not Interested', 'Follow Up Later']
}
],
webhooks: [
{
name: 'Call Events - Production',
url: 'https://yourapp.com/webhooks/sigmamind',
events: ['conversation_started', 'conversation_ended'],
webhookId: 'wh_BUbkx3PsbzQm5V10'
}
]
},
tools: [
{
type: 'voice_transfer_call',
transferTo: '+9187788XXXXX',
instruction: '<string>',
transferToRouting: 'static',
extensionNumber: '1234',
nodeId: '<string>',
toolName: '<string>'
}
]
})
};
fetch('https://api.sigmamind.ai/v1/agents/{agentId}', 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.sigmamind.ai/v1/agents/{agentId}",
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([
'agentName' => 'Auralis',
'instructions' => 'You are a helpful customer support assistant. Answer concisely and professionally.',
'welcomeMessageType' => 'static',
'welcomeMessage' => 'Welcome to our service! How can I assist you today?',
'agentSettings' => [
'language' => 'en_US',
'aiStartsConversation' => true,
'backgroundSound' => 'keyboard_typing',
'globalPrompt' => 'You are a professional virtual assistant. Always respond politely and keep answers concise.',
'remindersIntervalDuration' => 15,
'remindersLimit' => 3,
'endCallOnSilenceDuration' => 30,
'maxCallDuration' => 40,
'llmModel' => 'gpt-4o-mini',
'llmTemperature' => 0.5,
'llmTopP' => 0.5,
'llmTopK' => 40,
'voiceId' => 'elevenlabs_SGbOfpm28edC83pZ9iGb',
'voiceModelId' => 'eleven_turbo_v2_5',
'ttsSpeed' => 0.7,
'ttsTemperature' => 0.5,
'ttsVolume' => 0.5,
'aiStartsSpeakingPlan' => 0.5,
'aiStopsSpeakingPlan' => 0.5,
'ivrHangup' => true,
'agentTimezone' => 'Asia/Kolkata',
'autoVolumeNormalization' => true,
'backgroundNoiseFilter' => true,
'echoCancellation' => true,
'enablePostConversationAnalysis' => true,
'postConversationAnalysisLlmModel' => 'gpt-4o-mini',
'postConversationAnalysis' => [
[
'insightName' => 'conversation summary',
'insightInstructions' => '<string>',
'dataType' => 'string',
'options' => [
'Interested',
'Not Interested',
'Follow Up Later'
]
]
],
'webhooks' => [
[
'name' => 'Call Events - Production',
'url' => 'https://yourapp.com/webhooks/sigmamind',
'events' => [
'conversation_started',
'conversation_ended'
],
'webhookId' => 'wh_BUbkx3PsbzQm5V10'
]
]
],
'tools' => [
[
'type' => 'voice_transfer_call',
'transferTo' => '+9187788XXXXX',
'instruction' => '<string>',
'transferToRouting' => 'static',
'extensionNumber' => '1234',
'nodeId' => '<string>',
'toolName' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$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.sigmamind.ai/v1/agents/{agentId}"
payload := strings.NewReader("{\n \"agentName\": \"Auralis\",\n \"instructions\": \"You are a helpful customer support assistant. Answer concisely and professionally.\",\n \"welcomeMessageType\": \"static\",\n \"welcomeMessage\": \"Welcome to our service! How can I assist you today?\",\n \"agentSettings\": {\n \"language\": \"en_US\",\n \"aiStartsConversation\": true,\n \"backgroundSound\": \"keyboard_typing\",\n \"globalPrompt\": \"You are a professional virtual assistant. Always respond politely and keep answers concise.\",\n \"remindersIntervalDuration\": 15,\n \"remindersLimit\": 3,\n \"endCallOnSilenceDuration\": 30,\n \"maxCallDuration\": 40,\n \"llmModel\": \"gpt-4o-mini\",\n \"llmTemperature\": 0.5,\n \"llmTopP\": 0.5,\n \"llmTopK\": 40,\n \"voiceId\": \"elevenlabs_SGbOfpm28edC83pZ9iGb\",\n \"voiceModelId\": \"eleven_turbo_v2_5\",\n \"ttsSpeed\": 0.7,\n \"ttsTemperature\": 0.5,\n \"ttsVolume\": 0.5,\n \"aiStartsSpeakingPlan\": 0.5,\n \"aiStopsSpeakingPlan\": 0.5,\n \"ivrHangup\": true,\n \"agentTimezone\": \"Asia/Kolkata\",\n \"autoVolumeNormalization\": true,\n \"backgroundNoiseFilter\": true,\n \"echoCancellation\": true,\n \"enablePostConversationAnalysis\": true,\n \"postConversationAnalysisLlmModel\": \"gpt-4o-mini\",\n \"postConversationAnalysis\": [\n {\n \"insightName\": \"conversation summary\",\n \"insightInstructions\": \"<string>\",\n \"dataType\": \"string\",\n \"options\": [\n \"Interested\",\n \"Not Interested\",\n \"Follow Up Later\"\n ]\n }\n ],\n \"webhooks\": [\n {\n \"name\": \"Call Events - Production\",\n \"url\": \"https://yourapp.com/webhooks/sigmamind\",\n \"events\": [\n \"conversation_started\",\n \"conversation_ended\"\n ],\n \"webhookId\": \"wh_BUbkx3PsbzQm5V10\"\n }\n ]\n },\n \"tools\": [\n {\n \"type\": \"voice_transfer_call\",\n \"transferTo\": \"+9187788XXXXX\",\n \"instruction\": \"<string>\",\n \"transferToRouting\": \"static\",\n \"extensionNumber\": \"1234\",\n \"nodeId\": \"<string>\",\n \"toolName\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
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.sigmamind.ai/v1/agents/{agentId}")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"agentName\": \"Auralis\",\n \"instructions\": \"You are a helpful customer support assistant. Answer concisely and professionally.\",\n \"welcomeMessageType\": \"static\",\n \"welcomeMessage\": \"Welcome to our service! How can I assist you today?\",\n \"agentSettings\": {\n \"language\": \"en_US\",\n \"aiStartsConversation\": true,\n \"backgroundSound\": \"keyboard_typing\",\n \"globalPrompt\": \"You are a professional virtual assistant. Always respond politely and keep answers concise.\",\n \"remindersIntervalDuration\": 15,\n \"remindersLimit\": 3,\n \"endCallOnSilenceDuration\": 30,\n \"maxCallDuration\": 40,\n \"llmModel\": \"gpt-4o-mini\",\n \"llmTemperature\": 0.5,\n \"llmTopP\": 0.5,\n \"llmTopK\": 40,\n \"voiceId\": \"elevenlabs_SGbOfpm28edC83pZ9iGb\",\n \"voiceModelId\": \"eleven_turbo_v2_5\",\n \"ttsSpeed\": 0.7,\n \"ttsTemperature\": 0.5,\n \"ttsVolume\": 0.5,\n \"aiStartsSpeakingPlan\": 0.5,\n \"aiStopsSpeakingPlan\": 0.5,\n \"ivrHangup\": true,\n \"agentTimezone\": \"Asia/Kolkata\",\n \"autoVolumeNormalization\": true,\n \"backgroundNoiseFilter\": true,\n \"echoCancellation\": true,\n \"enablePostConversationAnalysis\": true,\n \"postConversationAnalysisLlmModel\": \"gpt-4o-mini\",\n \"postConversationAnalysis\": [\n {\n \"insightName\": \"conversation summary\",\n \"insightInstructions\": \"<string>\",\n \"dataType\": \"string\",\n \"options\": [\n \"Interested\",\n \"Not Interested\",\n \"Follow Up Later\"\n ]\n }\n ],\n \"webhooks\": [\n {\n \"name\": \"Call Events - Production\",\n \"url\": \"https://yourapp.com/webhooks/sigmamind\",\n \"events\": [\n \"conversation_started\",\n \"conversation_ended\"\n ],\n \"webhookId\": \"wh_BUbkx3PsbzQm5V10\"\n }\n ]\n },\n \"tools\": [\n {\n \"type\": \"voice_transfer_call\",\n \"transferTo\": \"+9187788XXXXX\",\n \"instruction\": \"<string>\",\n \"transferToRouting\": \"static\",\n \"extensionNumber\": \"1234\",\n \"nodeId\": \"<string>\",\n \"toolName\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sigmamind.ai/v1/agents/{agentId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"agentName\": \"Auralis\",\n \"instructions\": \"You are a helpful customer support assistant. Answer concisely and professionally.\",\n \"welcomeMessageType\": \"static\",\n \"welcomeMessage\": \"Welcome to our service! How can I assist you today?\",\n \"agentSettings\": {\n \"language\": \"en_US\",\n \"aiStartsConversation\": true,\n \"backgroundSound\": \"keyboard_typing\",\n \"globalPrompt\": \"You are a professional virtual assistant. Always respond politely and keep answers concise.\",\n \"remindersIntervalDuration\": 15,\n \"remindersLimit\": 3,\n \"endCallOnSilenceDuration\": 30,\n \"maxCallDuration\": 40,\n \"llmModel\": \"gpt-4o-mini\",\n \"llmTemperature\": 0.5,\n \"llmTopP\": 0.5,\n \"llmTopK\": 40,\n \"voiceId\": \"elevenlabs_SGbOfpm28edC83pZ9iGb\",\n \"voiceModelId\": \"eleven_turbo_v2_5\",\n \"ttsSpeed\": 0.7,\n \"ttsTemperature\": 0.5,\n \"ttsVolume\": 0.5,\n \"aiStartsSpeakingPlan\": 0.5,\n \"aiStopsSpeakingPlan\": 0.5,\n \"ivrHangup\": true,\n \"agentTimezone\": \"Asia/Kolkata\",\n \"autoVolumeNormalization\": true,\n \"backgroundNoiseFilter\": true,\n \"echoCancellation\": true,\n \"enablePostConversationAnalysis\": true,\n \"postConversationAnalysisLlmModel\": \"gpt-4o-mini\",\n \"postConversationAnalysis\": [\n {\n \"insightName\": \"conversation summary\",\n \"insightInstructions\": \"<string>\",\n \"dataType\": \"string\",\n \"options\": [\n \"Interested\",\n \"Not Interested\",\n \"Follow Up Later\"\n ]\n }\n ],\n \"webhooks\": [\n {\n \"name\": \"Call Events - Production\",\n \"url\": \"https://yourapp.com/webhooks/sigmamind\",\n \"events\": [\n \"conversation_started\",\n \"conversation_ended\"\n ],\n \"webhookId\": \"wh_BUbkx3PsbzQm5V10\"\n }\n ]\n },\n \"tools\": [\n {\n \"type\": \"voice_transfer_call\",\n \"transferTo\": \"+9187788XXXXX\",\n \"instruction\": \"<string>\",\n \"transferToRouting\": \"static\",\n \"extensionNumber\": \"1234\",\n \"nodeId\": \"<string>\",\n \"toolName\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"agentId": "SPIlVscbB0kkXBvZ",
"agentName": "Auralis",
"instructions": "You are a helpful customer support assistant. Answer concisely and professionally.",
"welcomeMessageType": "static",
"welcomeMessage": "Welcome to our service! How can I assist you today?",
"agentSettings": {
"language": "en_US",
"aiStartsConversation": true,
"backgroundSound": "keyboard_typing",
"globalPrompt": "You are a professional virtual assistant. Always respond politely and keep answers concise.",
"remindersIntervalDuration": 15,
"remindersLimit": 3,
"endCallOnSilenceDuration": 30,
"maxCallDuration": 40,
"llmModel": "gpt-4o-mini",
"llmTemperature": 0.5,
"llmTopP": 0.5,
"llmTopK": 40,
"voiceId": "elevenlabs_SGbOfpm28edC83pZ9iGb",
"voiceModelId": "eleven_turbo_v2_5",
"ttsSpeed": 0.7,
"ttsTemperature": 0.5,
"ttsVolume": 0.5,
"aiStartsSpeakingPlan": 0.5,
"aiStopsSpeakingPlan": 0.5,
"ivrHangup": true,
"agentTimezone": "Asia/Kolkata",
"autoVolumeNormalization": true,
"backgroundNoiseFilter": true,
"echoCancellation": true,
"enablePostConversationAnalysis": true,
"postConversationAnalysisLlmModel": "gpt-4o-mini",
"postConversationAnalysis": [
{
"insightName": "conversation summary",
"insightInstructions": "<string>",
"dataType": "string",
"options": [
"Interested",
"Not Interested",
"Follow Up Later"
]
}
],
"webhooks": [
{
"webhookId": "wh_BUbkx3PsbzQm5V10",
"name": "My Webhook",
"url": "https://example.com/webhook",
"secret": "mK9vXq2pL8nR5tY1wA3sD6fH0jC4bE7u",
"events": [
"<string>"
]
}
]
},
"tools": [
{
"type": "voice_transfer_call",
"nodeId": "<string>",
"toolName": "<string>",
"instruction": "<string>",
"transferToRouting": "static",
"transferTo": "+9187788XXXXX",
"extensionNumber": "1234",
"transferSettings": {
"transferType": "warm",
"ringingDuration": 40,
"waitForParticipantAnswer": true,
"enableWhisperMessage": true,
"whisperMessage": "<string>",
"whisperMessageType": "static",
"enableThreeWayMessage": true,
"threeWayMessage": "<string>",
"threeWayMessageType": "static",
"customHeaders": {}
}
}
]
}{
"error": "Bad Request",
"message": "Invalid request parameters",
"path": "/v1/agents",
"status": 400,
"timestamp": "2026-05-05T10:06:46.023Z"
}{
"error": "Unauthorized",
"message": "X-API-Key is missing or invalid",
"path": "/v1/agents",
"status": 401,
"timestamp": "2026-05-05T10:06:46.023Z"
}{
"error": "Forbidden",
"message": "Access denied for this resource",
"path": "/v1/agents",
"status": 403,
"timestamp": "2026-05-05T10:06:46.023Z"
}{
"error": "Not Found",
"message": "The requested resource was not found",
"path": "/v1/agents",
"status": 404,
"timestamp": "2026-05-05T10:06:46.023Z"
}{
"error": "Internal Server Error",
"message": "Unexpected server error",
"path": "/v1/agents",
"status": 500,
"timestamp": "2026-05-05T10:06:46.023Z"
}Single Prompt Agents
Update Agent
Partially updates an existing agent by agentId. Only fields provided in the request body are updated — omitted fields remain unchanged. Returns the updated agent record.
PATCH
/
v1
/
agents
/
{agentId}
Update Agent
curl --request PATCH \
--url https://api.sigmamind.ai/v1/agents/{agentId} \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"agentName": "Auralis",
"instructions": "You are a helpful customer support assistant. Answer concisely and professionally.",
"welcomeMessageType": "static",
"welcomeMessage": "Welcome to our service! How can I assist you today?",
"agentSettings": {
"language": "en_US",
"aiStartsConversation": true,
"backgroundSound": "keyboard_typing",
"globalPrompt": "You are a professional virtual assistant. Always respond politely and keep answers concise.",
"remindersIntervalDuration": 15,
"remindersLimit": 3,
"endCallOnSilenceDuration": 30,
"maxCallDuration": 40,
"llmModel": "gpt-4o-mini",
"llmTemperature": 0.5,
"llmTopP": 0.5,
"llmTopK": 40,
"voiceId": "elevenlabs_SGbOfpm28edC83pZ9iGb",
"voiceModelId": "eleven_turbo_v2_5",
"ttsSpeed": 0.7,
"ttsTemperature": 0.5,
"ttsVolume": 0.5,
"aiStartsSpeakingPlan": 0.5,
"aiStopsSpeakingPlan": 0.5,
"ivrHangup": true,
"agentTimezone": "Asia/Kolkata",
"autoVolumeNormalization": true,
"backgroundNoiseFilter": true,
"echoCancellation": true,
"enablePostConversationAnalysis": true,
"postConversationAnalysisLlmModel": "gpt-4o-mini",
"postConversationAnalysis": [
{
"insightName": "conversation summary",
"insightInstructions": "<string>",
"dataType": "string",
"options": [
"Interested",
"Not Interested",
"Follow Up Later"
]
}
],
"webhooks": [
{
"name": "Call Events - Production",
"url": "https://yourapp.com/webhooks/sigmamind",
"events": [
"conversation_started",
"conversation_ended"
],
"webhookId": "wh_BUbkx3PsbzQm5V10"
}
]
},
"tools": [
{
"type": "voice_transfer_call",
"transferTo": "+9187788XXXXX",
"instruction": "<string>",
"transferToRouting": "static",
"extensionNumber": "1234",
"nodeId": "<string>",
"toolName": "<string>"
}
]
}
'import requests
url = "https://api.sigmamind.ai/v1/agents/{agentId}"
payload = {
"agentName": "Auralis",
"instructions": "You are a helpful customer support assistant. Answer concisely and professionally.",
"welcomeMessageType": "static",
"welcomeMessage": "Welcome to our service! How can I assist you today?",
"agentSettings": {
"language": "en_US",
"aiStartsConversation": True,
"backgroundSound": "keyboard_typing",
"globalPrompt": "You are a professional virtual assistant. Always respond politely and keep answers concise.",
"remindersIntervalDuration": 15,
"remindersLimit": 3,
"endCallOnSilenceDuration": 30,
"maxCallDuration": 40,
"llmModel": "gpt-4o-mini",
"llmTemperature": 0.5,
"llmTopP": 0.5,
"llmTopK": 40,
"voiceId": "elevenlabs_SGbOfpm28edC83pZ9iGb",
"voiceModelId": "eleven_turbo_v2_5",
"ttsSpeed": 0.7,
"ttsTemperature": 0.5,
"ttsVolume": 0.5,
"aiStartsSpeakingPlan": 0.5,
"aiStopsSpeakingPlan": 0.5,
"ivrHangup": True,
"agentTimezone": "Asia/Kolkata",
"autoVolumeNormalization": True,
"backgroundNoiseFilter": True,
"echoCancellation": True,
"enablePostConversationAnalysis": True,
"postConversationAnalysisLlmModel": "gpt-4o-mini",
"postConversationAnalysis": [
{
"insightName": "conversation summary",
"insightInstructions": "<string>",
"dataType": "string",
"options": ["Interested", "Not Interested", "Follow Up Later"]
}
],
"webhooks": [
{
"name": "Call Events - Production",
"url": "https://yourapp.com/webhooks/sigmamind",
"events": ["conversation_started", "conversation_ended"],
"webhookId": "wh_BUbkx3PsbzQm5V10"
}
]
},
"tools": [
{
"type": "voice_transfer_call",
"transferTo": "+9187788XXXXX",
"instruction": "<string>",
"transferToRouting": "static",
"extensionNumber": "1234",
"nodeId": "<string>",
"toolName": "<string>"
}
]
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
agentName: 'Auralis',
instructions: 'You are a helpful customer support assistant. Answer concisely and professionally.',
welcomeMessageType: 'static',
welcomeMessage: 'Welcome to our service! How can I assist you today?',
agentSettings: {
language: 'en_US',
aiStartsConversation: true,
backgroundSound: 'keyboard_typing',
globalPrompt: 'You are a professional virtual assistant. Always respond politely and keep answers concise.',
remindersIntervalDuration: 15,
remindersLimit: 3,
endCallOnSilenceDuration: 30,
maxCallDuration: 40,
llmModel: 'gpt-4o-mini',
llmTemperature: 0.5,
llmTopP: 0.5,
llmTopK: 40,
voiceId: 'elevenlabs_SGbOfpm28edC83pZ9iGb',
voiceModelId: 'eleven_turbo_v2_5',
ttsSpeed: 0.7,
ttsTemperature: 0.5,
ttsVolume: 0.5,
aiStartsSpeakingPlan: 0.5,
aiStopsSpeakingPlan: 0.5,
ivrHangup: true,
agentTimezone: 'Asia/Kolkata',
autoVolumeNormalization: true,
backgroundNoiseFilter: true,
echoCancellation: true,
enablePostConversationAnalysis: true,
postConversationAnalysisLlmModel: 'gpt-4o-mini',
postConversationAnalysis: [
{
insightName: 'conversation summary',
insightInstructions: '<string>',
dataType: 'string',
options: ['Interested', 'Not Interested', 'Follow Up Later']
}
],
webhooks: [
{
name: 'Call Events - Production',
url: 'https://yourapp.com/webhooks/sigmamind',
events: ['conversation_started', 'conversation_ended'],
webhookId: 'wh_BUbkx3PsbzQm5V10'
}
]
},
tools: [
{
type: 'voice_transfer_call',
transferTo: '+9187788XXXXX',
instruction: '<string>',
transferToRouting: 'static',
extensionNumber: '1234',
nodeId: '<string>',
toolName: '<string>'
}
]
})
};
fetch('https://api.sigmamind.ai/v1/agents/{agentId}', 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.sigmamind.ai/v1/agents/{agentId}",
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([
'agentName' => 'Auralis',
'instructions' => 'You are a helpful customer support assistant. Answer concisely and professionally.',
'welcomeMessageType' => 'static',
'welcomeMessage' => 'Welcome to our service! How can I assist you today?',
'agentSettings' => [
'language' => 'en_US',
'aiStartsConversation' => true,
'backgroundSound' => 'keyboard_typing',
'globalPrompt' => 'You are a professional virtual assistant. Always respond politely and keep answers concise.',
'remindersIntervalDuration' => 15,
'remindersLimit' => 3,
'endCallOnSilenceDuration' => 30,
'maxCallDuration' => 40,
'llmModel' => 'gpt-4o-mini',
'llmTemperature' => 0.5,
'llmTopP' => 0.5,
'llmTopK' => 40,
'voiceId' => 'elevenlabs_SGbOfpm28edC83pZ9iGb',
'voiceModelId' => 'eleven_turbo_v2_5',
'ttsSpeed' => 0.7,
'ttsTemperature' => 0.5,
'ttsVolume' => 0.5,
'aiStartsSpeakingPlan' => 0.5,
'aiStopsSpeakingPlan' => 0.5,
'ivrHangup' => true,
'agentTimezone' => 'Asia/Kolkata',
'autoVolumeNormalization' => true,
'backgroundNoiseFilter' => true,
'echoCancellation' => true,
'enablePostConversationAnalysis' => true,
'postConversationAnalysisLlmModel' => 'gpt-4o-mini',
'postConversationAnalysis' => [
[
'insightName' => 'conversation summary',
'insightInstructions' => '<string>',
'dataType' => 'string',
'options' => [
'Interested',
'Not Interested',
'Follow Up Later'
]
]
],
'webhooks' => [
[
'name' => 'Call Events - Production',
'url' => 'https://yourapp.com/webhooks/sigmamind',
'events' => [
'conversation_started',
'conversation_ended'
],
'webhookId' => 'wh_BUbkx3PsbzQm5V10'
]
]
],
'tools' => [
[
'type' => 'voice_transfer_call',
'transferTo' => '+9187788XXXXX',
'instruction' => '<string>',
'transferToRouting' => 'static',
'extensionNumber' => '1234',
'nodeId' => '<string>',
'toolName' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$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.sigmamind.ai/v1/agents/{agentId}"
payload := strings.NewReader("{\n \"agentName\": \"Auralis\",\n \"instructions\": \"You are a helpful customer support assistant. Answer concisely and professionally.\",\n \"welcomeMessageType\": \"static\",\n \"welcomeMessage\": \"Welcome to our service! How can I assist you today?\",\n \"agentSettings\": {\n \"language\": \"en_US\",\n \"aiStartsConversation\": true,\n \"backgroundSound\": \"keyboard_typing\",\n \"globalPrompt\": \"You are a professional virtual assistant. Always respond politely and keep answers concise.\",\n \"remindersIntervalDuration\": 15,\n \"remindersLimit\": 3,\n \"endCallOnSilenceDuration\": 30,\n \"maxCallDuration\": 40,\n \"llmModel\": \"gpt-4o-mini\",\n \"llmTemperature\": 0.5,\n \"llmTopP\": 0.5,\n \"llmTopK\": 40,\n \"voiceId\": \"elevenlabs_SGbOfpm28edC83pZ9iGb\",\n \"voiceModelId\": \"eleven_turbo_v2_5\",\n \"ttsSpeed\": 0.7,\n \"ttsTemperature\": 0.5,\n \"ttsVolume\": 0.5,\n \"aiStartsSpeakingPlan\": 0.5,\n \"aiStopsSpeakingPlan\": 0.5,\n \"ivrHangup\": true,\n \"agentTimezone\": \"Asia/Kolkata\",\n \"autoVolumeNormalization\": true,\n \"backgroundNoiseFilter\": true,\n \"echoCancellation\": true,\n \"enablePostConversationAnalysis\": true,\n \"postConversationAnalysisLlmModel\": \"gpt-4o-mini\",\n \"postConversationAnalysis\": [\n {\n \"insightName\": \"conversation summary\",\n \"insightInstructions\": \"<string>\",\n \"dataType\": \"string\",\n \"options\": [\n \"Interested\",\n \"Not Interested\",\n \"Follow Up Later\"\n ]\n }\n ],\n \"webhooks\": [\n {\n \"name\": \"Call Events - Production\",\n \"url\": \"https://yourapp.com/webhooks/sigmamind\",\n \"events\": [\n \"conversation_started\",\n \"conversation_ended\"\n ],\n \"webhookId\": \"wh_BUbkx3PsbzQm5V10\"\n }\n ]\n },\n \"tools\": [\n {\n \"type\": \"voice_transfer_call\",\n \"transferTo\": \"+9187788XXXXX\",\n \"instruction\": \"<string>\",\n \"transferToRouting\": \"static\",\n \"extensionNumber\": \"1234\",\n \"nodeId\": \"<string>\",\n \"toolName\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
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.sigmamind.ai/v1/agents/{agentId}")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"agentName\": \"Auralis\",\n \"instructions\": \"You are a helpful customer support assistant. Answer concisely and professionally.\",\n \"welcomeMessageType\": \"static\",\n \"welcomeMessage\": \"Welcome to our service! How can I assist you today?\",\n \"agentSettings\": {\n \"language\": \"en_US\",\n \"aiStartsConversation\": true,\n \"backgroundSound\": \"keyboard_typing\",\n \"globalPrompt\": \"You are a professional virtual assistant. Always respond politely and keep answers concise.\",\n \"remindersIntervalDuration\": 15,\n \"remindersLimit\": 3,\n \"endCallOnSilenceDuration\": 30,\n \"maxCallDuration\": 40,\n \"llmModel\": \"gpt-4o-mini\",\n \"llmTemperature\": 0.5,\n \"llmTopP\": 0.5,\n \"llmTopK\": 40,\n \"voiceId\": \"elevenlabs_SGbOfpm28edC83pZ9iGb\",\n \"voiceModelId\": \"eleven_turbo_v2_5\",\n \"ttsSpeed\": 0.7,\n \"ttsTemperature\": 0.5,\n \"ttsVolume\": 0.5,\n \"aiStartsSpeakingPlan\": 0.5,\n \"aiStopsSpeakingPlan\": 0.5,\n \"ivrHangup\": true,\n \"agentTimezone\": \"Asia/Kolkata\",\n \"autoVolumeNormalization\": true,\n \"backgroundNoiseFilter\": true,\n \"echoCancellation\": true,\n \"enablePostConversationAnalysis\": true,\n \"postConversationAnalysisLlmModel\": \"gpt-4o-mini\",\n \"postConversationAnalysis\": [\n {\n \"insightName\": \"conversation summary\",\n \"insightInstructions\": \"<string>\",\n \"dataType\": \"string\",\n \"options\": [\n \"Interested\",\n \"Not Interested\",\n \"Follow Up Later\"\n ]\n }\n ],\n \"webhooks\": [\n {\n \"name\": \"Call Events - Production\",\n \"url\": \"https://yourapp.com/webhooks/sigmamind\",\n \"events\": [\n \"conversation_started\",\n \"conversation_ended\"\n ],\n \"webhookId\": \"wh_BUbkx3PsbzQm5V10\"\n }\n ]\n },\n \"tools\": [\n {\n \"type\": \"voice_transfer_call\",\n \"transferTo\": \"+9187788XXXXX\",\n \"instruction\": \"<string>\",\n \"transferToRouting\": \"static\",\n \"extensionNumber\": \"1234\",\n \"nodeId\": \"<string>\",\n \"toolName\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sigmamind.ai/v1/agents/{agentId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"agentName\": \"Auralis\",\n \"instructions\": \"You are a helpful customer support assistant. Answer concisely and professionally.\",\n \"welcomeMessageType\": \"static\",\n \"welcomeMessage\": \"Welcome to our service! How can I assist you today?\",\n \"agentSettings\": {\n \"language\": \"en_US\",\n \"aiStartsConversation\": true,\n \"backgroundSound\": \"keyboard_typing\",\n \"globalPrompt\": \"You are a professional virtual assistant. Always respond politely and keep answers concise.\",\n \"remindersIntervalDuration\": 15,\n \"remindersLimit\": 3,\n \"endCallOnSilenceDuration\": 30,\n \"maxCallDuration\": 40,\n \"llmModel\": \"gpt-4o-mini\",\n \"llmTemperature\": 0.5,\n \"llmTopP\": 0.5,\n \"llmTopK\": 40,\n \"voiceId\": \"elevenlabs_SGbOfpm28edC83pZ9iGb\",\n \"voiceModelId\": \"eleven_turbo_v2_5\",\n \"ttsSpeed\": 0.7,\n \"ttsTemperature\": 0.5,\n \"ttsVolume\": 0.5,\n \"aiStartsSpeakingPlan\": 0.5,\n \"aiStopsSpeakingPlan\": 0.5,\n \"ivrHangup\": true,\n \"agentTimezone\": \"Asia/Kolkata\",\n \"autoVolumeNormalization\": true,\n \"backgroundNoiseFilter\": true,\n \"echoCancellation\": true,\n \"enablePostConversationAnalysis\": true,\n \"postConversationAnalysisLlmModel\": \"gpt-4o-mini\",\n \"postConversationAnalysis\": [\n {\n \"insightName\": \"conversation summary\",\n \"insightInstructions\": \"<string>\",\n \"dataType\": \"string\",\n \"options\": [\n \"Interested\",\n \"Not Interested\",\n \"Follow Up Later\"\n ]\n }\n ],\n \"webhooks\": [\n {\n \"name\": \"Call Events - Production\",\n \"url\": \"https://yourapp.com/webhooks/sigmamind\",\n \"events\": [\n \"conversation_started\",\n \"conversation_ended\"\n ],\n \"webhookId\": \"wh_BUbkx3PsbzQm5V10\"\n }\n ]\n },\n \"tools\": [\n {\n \"type\": \"voice_transfer_call\",\n \"transferTo\": \"+9187788XXXXX\",\n \"instruction\": \"<string>\",\n \"transferToRouting\": \"static\",\n \"extensionNumber\": \"1234\",\n \"nodeId\": \"<string>\",\n \"toolName\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"agentId": "SPIlVscbB0kkXBvZ",
"agentName": "Auralis",
"instructions": "You are a helpful customer support assistant. Answer concisely and professionally.",
"welcomeMessageType": "static",
"welcomeMessage": "Welcome to our service! How can I assist you today?",
"agentSettings": {
"language": "en_US",
"aiStartsConversation": true,
"backgroundSound": "keyboard_typing",
"globalPrompt": "You are a professional virtual assistant. Always respond politely and keep answers concise.",
"remindersIntervalDuration": 15,
"remindersLimit": 3,
"endCallOnSilenceDuration": 30,
"maxCallDuration": 40,
"llmModel": "gpt-4o-mini",
"llmTemperature": 0.5,
"llmTopP": 0.5,
"llmTopK": 40,
"voiceId": "elevenlabs_SGbOfpm28edC83pZ9iGb",
"voiceModelId": "eleven_turbo_v2_5",
"ttsSpeed": 0.7,
"ttsTemperature": 0.5,
"ttsVolume": 0.5,
"aiStartsSpeakingPlan": 0.5,
"aiStopsSpeakingPlan": 0.5,
"ivrHangup": true,
"agentTimezone": "Asia/Kolkata",
"autoVolumeNormalization": true,
"backgroundNoiseFilter": true,
"echoCancellation": true,
"enablePostConversationAnalysis": true,
"postConversationAnalysisLlmModel": "gpt-4o-mini",
"postConversationAnalysis": [
{
"insightName": "conversation summary",
"insightInstructions": "<string>",
"dataType": "string",
"options": [
"Interested",
"Not Interested",
"Follow Up Later"
]
}
],
"webhooks": [
{
"webhookId": "wh_BUbkx3PsbzQm5V10",
"name": "My Webhook",
"url": "https://example.com/webhook",
"secret": "mK9vXq2pL8nR5tY1wA3sD6fH0jC4bE7u",
"events": [
"<string>"
]
}
]
},
"tools": [
{
"type": "voice_transfer_call",
"nodeId": "<string>",
"toolName": "<string>",
"instruction": "<string>",
"transferToRouting": "static",
"transferTo": "+9187788XXXXX",
"extensionNumber": "1234",
"transferSettings": {
"transferType": "warm",
"ringingDuration": 40,
"waitForParticipantAnswer": true,
"enableWhisperMessage": true,
"whisperMessage": "<string>",
"whisperMessageType": "static",
"enableThreeWayMessage": true,
"threeWayMessage": "<string>",
"threeWayMessageType": "static",
"customHeaders": {}
}
}
]
}{
"error": "Bad Request",
"message": "Invalid request parameters",
"path": "/v1/agents",
"status": 400,
"timestamp": "2026-05-05T10:06:46.023Z"
}{
"error": "Unauthorized",
"message": "X-API-Key is missing or invalid",
"path": "/v1/agents",
"status": 401,
"timestamp": "2026-05-05T10:06:46.023Z"
}{
"error": "Forbidden",
"message": "Access denied for this resource",
"path": "/v1/agents",
"status": 403,
"timestamp": "2026-05-05T10:06:46.023Z"
}{
"error": "Not Found",
"message": "The requested resource was not found",
"path": "/v1/agents",
"status": 404,
"timestamp": "2026-05-05T10:06:46.023Z"
}{
"error": "Internal Server Error",
"message": "Unexpected server error",
"path": "/v1/agents",
"status": 500,
"timestamp": "2026-05-05T10:06:46.023Z"
}Authorizations
Authenticate every request by passing your API key in the X-API-Key header. To get your key, go to Dashboard → API Keys and create or copy your Production API key.
Path Parameters
Unique identifier of the agent to update.
Body
application/json
Request body for updating an existing single prompt agent, including its instructions, welcome message configuration, runtime settings, and available tools.
Human-readable name of the agent used to identify it in the dashboard and APIs.
Example:
"Auralis"
Core system prompt that defines the agent’s behavior, personality, tone, response style, goals, and task handling logic. These instructions guide how the agent interacts with users and responds during conversations.
Example:
"You are a helpful customer support assistant. Answer concisely and professionally."
Determines how the agent’s welcome message is generated. Use 'static' to send a fixed predefined message, or 'prompt' to dynamically generate the welcome message using AI instructions.
Available options:
static, prompt Example:
"static"
The content of the welcome message. If 'welcomeMessageType' is 'static', this contains the exact message shown to the user. If it is 'prompt', this contains the prompt used to generate the welcome message dynamically.
Example:
"Welcome to our service! How can I assist you today?"
Request body for updating an existing AI agent, including its instructions, welcome message configuration, runtime settings, and available tools.
Show child attributes
Show child attributes
Transfers the active voice call to another number
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
Show child attributes
Show child attributes
Response
OK
Id of the agent.
Example:
"SPIlVscbB0kkXBvZ"
Human-readable name of the agent used to identify it in the dashboard and APIs.
Example:
"Auralis"
Core system prompt that defines the agent’s behavior, personality, tone, response style, goals, and task handling logic. These instructions guide how the agent interacts with users and responds during conversations.
Example:
"You are a helpful customer support assistant. Answer concisely and professionally."
Determines how the agent’s welcome message is generated. Use 'static' to send a fixed predefined message, or 'prompt' to dynamically generate the welcome message using AI instructions.
Available options:
static, prompt Example:
"static"
The content of the welcome message. If 'welcomeMessageType' is 'static', this contains the exact message shown to the user. If it is 'prompt', this contains the prompt used to generate the welcome message dynamically.
Example:
"Welcome to our service! How can I assist you today?"
Configuration settings that define the agent’s runtime behavior, including voice, llm model and other operational settings.
Show child attributes
Show child attributes
Transfers the active voice call to another number
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
Show child attributes
Show child attributes
⌘I