SIsigmamind
Conversational Agents

Get conversational Agent

Changed on

Get a conversational agent, along with agent settings

get/v1/conversational-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

The unique identifier of the agent within the system.

agentNamestring

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

startNodeNamestring

The name of the node where the agent workflow starts.

startNodeIdstring

The unique identifier of the node where the agent workflow starts.

Example response

{
  "agentId": "SPIlVscbB0kkXBvZ",
  "agentName": "Auralis",
  "startNodeName": "Welcome",
  "startNodeId": "node_01HXYZ123",
  "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"
      }
    ]
  },
  "nodes": [
    {
      "nodeId": "node_wcCIoGrJbw9AlXVk",
      "nodeName": "get_customer_detail",
      "nodeType": "message",
      "edge": {
        "nextNodeId": "node_wcCIoGrJbw9AlXVk",
        "nextNodeName": "get_customer_detail"
      },
      "parameters": {
        "instructionsType": "static",
        "instructions": "Hello! How can I help you today?"
      }
    }
  ]
}

Changes