SIsigmamind
Single Prompt Agents

List Agents

Changed on

Retrieve a paginated list of all single prompt agents available in the account along with their details and configurations.

get/v1/agents

Request

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

Query parameters

pageinteger

Zero-based page number to retrieve. Use 0 for the first page. Must be 0 or greater.

sizeinteger

Number of single prompt changes to retrieve per page. Must be 1 or greater.

Response

OK

pageinteger

Current page number (0-based index). Indicates which page of results is being returned.

sizeinteger

Number of items requested per page. Determines the maximum size of the 'data' list.

totalCountinteger

Total number of records available across all pages. Useful for calculating pagination on the client side.

totalPagesinteger

Total number of pages available based on totalCounts and size. Helps clients understand how many pages exist in total.

hasNextboolean

Indicates whether there is a next page available after the current one. Useful for implementing 'Load More' or next navigation.

hasPreviousboolean

Indicates whether there is a previous page before the current one. Useful for enabling backward navigation.

Example response

{
  "data": [
    {
      "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