SIsigmamind
Single Prompt Agents

Get Agent

Changed on

Retrieves the full details of a single prompt agent, along with agent settings.

get/v1/agents/{agentId}

Request

  • Base URL
    https://api.sigmamind.ai
  • Auth
    API key in header X-API-Key

Path parameters

agentIdstring required

Unique identifier of the agent to be retrieved.

Response

OK

agentIdstring

Id of the agent.

agentNamestring

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

instructionsstring

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.

welcomeMessageType'static' | 'prompt'

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.

welcomeMessagestring

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 response

{
  "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",
        "dataType": "string",
        "options": [
          "Interested",
          "Not Interested",
          "Follow Up Later"
        ]
      }
    ],
    "webhooks": [
      {
        "webhookId": "wh_BUbkx3PsbzQm5V10",
        "name": "My Webhook",
        "url": "https://example.com/webhook",
        "secret": "mK9vXq2pL8nR5tY1wA3sD6fH0jC4bE7u"
      }
    ]
  },
  "tools": [
    {
      "type": "voice_transfer_call",
      "transferToRouting": "static",
      "transferTo": "+9187788XXXXX",
      "extensionNumber": "1234",
      "transferSettings": {
        "ringingDuration": 40
      }
    }
  ]
}

Changes

  • 64c0435b10ebRevision changes
    • info

      added voice_transfer_call extract_variables ivr_navigator voice_end_call integration_tool discriminator mapping keys to the / response property for the response status