Get Agent
curl --request GET \
--url https://api.sigmamind.ai/v1/agents/{agentId} \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.sigmamind.ai/v1/agents/{agentId}"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
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 => "GET",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "https://api.sigmamind.ai/v1/agents/{agentId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.sigmamind.ai/v1/agents/{agentId}")
.header("X-API-Key", "<api-key>")
.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::Get.new(url)
request["X-API-Key"] = '<api-key>'
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-04T14:44:41.760Z"
}{
"error": "Unauthorized",
"message": "X-API-Key is missing or invalid",
"path": "/v1/agents",
"status": 401,
"timestamp": "2026-05-04T14:44:41.760Z"
}{
"error": "Forbidden",
"message": "Access denied for this resource",
"path": "/v1/agents",
"status": 403,
"timestamp": "2026-05-04T14:44:41.760Z"
}{
"error": "Not Found",
"message": "The requested resource was not found",
"path": "/v1/agents",
"status": 404,
"timestamp": "2026-05-04T14:44:41.760Z"
}{
"error": "Internal Server Error",
"message": "Unexpected server error",
"path": "/v1/agents",
"status": 500,
"timestamp": "2026-05-04T14:44:41.760Z"
}Single Prompt Agents
Get Agent
Retrieves the full details of a single prompt agent, along with agent settings.
GET
/
v1
/
agents
/
{agentId}
Get Agent
curl --request GET \
--url https://api.sigmamind.ai/v1/agents/{agentId} \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.sigmamind.ai/v1/agents/{agentId}"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
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 => "GET",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "https://api.sigmamind.ai/v1/agents/{agentId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.sigmamind.ai/v1/agents/{agentId}")
.header("X-API-Key", "<api-key>")
.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::Get.new(url)
request["X-API-Key"] = '<api-key>'
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-04T14:44:41.760Z"
}{
"error": "Unauthorized",
"message": "X-API-Key is missing or invalid",
"path": "/v1/agents",
"status": 401,
"timestamp": "2026-05-04T14:44:41.760Z"
}{
"error": "Forbidden",
"message": "Access denied for this resource",
"path": "/v1/agents",
"status": 403,
"timestamp": "2026-05-04T14:44:41.760Z"
}{
"error": "Not Found",
"message": "The requested resource was not found",
"path": "/v1/agents",
"status": 404,
"timestamp": "2026-05-04T14:44:41.760Z"
}{
"error": "Internal Server Error",
"message": "Unexpected server error",
"path": "/v1/agents",
"status": 500,
"timestamp": "2026-05-04T14:44:41.760Z"
}Authorizations
Response
OK
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."