Skip to main content
GET
/
v1
/
agents
/
{agentId}
Get Agent
curl --request GET \
  --url https://api.sigmamind.ai/v1/agents/{agentId} \
  --header 'X-API-Key: <api-key>'
{
  "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",
      "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": {}
      }
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.sigmamind.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-API-Key
string
header
required

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

​
agentId
string
required

Unique identifier of the agent to be retrieved.

Response

OK

​
agentId
string

Id of the agent.

Example:

"SPIlVscbB0kkXBvZ"

​
agentName
string

Human-readable name of the agent used to identify it in the dashboard and APIs.

Example:

"Auralis"

​
instructions
string

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."

​
welcomeMessageType
enum<string>
default:static

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"

​
welcomeMessage
string

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?"

​
agentSettings
object

Configuration settings that define the agent’s runtime behavior, including voice, llm model and other operational settings.

​
tools
object[]

Transfers the active voice call to another number