Create Agent

Creates a new single prompt agent with the specified configuration, including system prompt and agent settings. Returns the created agent including its agentId, which is required for all subsequent update, call, and simulation operations.

Request body

agentNamestring

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

instructionsstring required

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 request

{
  "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": [
      {
        "name": "Call Events - Production",
        "url": "https://yourapp.com/webhooks/sigmamind",
        "events": [
          "conversation_started",
          "conversation_ended"
        ]
      }
    ]
  },
  "tools": [
    {
      "type": "voice_transfer_call",
      "transferToRouting": "static",
      "transferTo": "+9187788XXXXX",
      "extensionNumber": "1234",
      "transferSettings": {
        "ringingDuration": 40
      }
    }
  ]
}

Response

Created

agentIdstring

Id of the agent.