Get Agent

GET 
/conversation-ai/agents/:agentId

Retrieves a specific AI agent by its ID. Returns the complete agent configuration including name, status, actions, and settings.

Request

Version stringrequired

API Version

Available optionsv3

agentId stringrequired

Conversations AI agent id

application/json

Successful response

application/json

Schema

Schema

idstringrequired

Unique identifier for the agent.

namestringrequired

Name of the agent.

businessNamestring

Name of the business the agent represents.

modestringrequired
Current operating mode of the agent.
Available optionsoffsuggestiveauto-pilot
channelsstring[]required
Communication channels the agent operates on.
Available optionsIGFBSMSWebChatWhatsAppLive_ChatEmail
waitTimenumberrequired

Wait time before agent responds.

waitTimeUnitstringrequired
Unit for wait time.
Available optionsminutesseconds
sleepEnabledbooleanrequireddeprecated

Indicates if sleep functionality is enabled.

sleepOnManualMessageboolean

Whether the bot sleeps on manual outbound messages.

sleepOnWorkflowMessageboolean

Whether the bot sleeps on workflow outbound messages.

sleepTimenumber

Duration of sleep period.

sleepTimeUnitstring
Unit of sleep time.
Available optionshoursminutesseconds
emailWaitTimenumber

Email-specific wait time (max 12 hours).

emailWaitTimeUnitstring
Unit for email wait time.
Available optionssecondsminuteshours
emailSettingsobject

Email channel formatting settings.

actionsobject[]required

List of actions associated with this agent.

isPrimarybooleanrequired

Indicates if this agent is a primary agent.

autoPilotMaxMessagesnumberrequired

Maximum number of messages in auto-pilot mode before requiring human intervention.

goalstring

The goal of the agent.

personalitystring

Personality traits of the agent.

instructionsstring

Instructions for the agent.

fullPromptstring

Complete agent prompt when stored; when set and non-empty, used as the source of truth at generation time.

knowledgeBaseIdsstring[]

Array of knowledge base IDs associated with this agent.

knowledgeBaseTriggersobject[]

Knowledge base trigger configurations

workingHoursobjectnullable

Working-hours schedule for this agent, or null when not configured. Manage it via the /working-hours routes.

Example (auto)

{
  "id": "emp_123",
  "name": "John Doe",
  "businessName": "Tech Corp",
  "mode": "auto-pilot",
  "channels": [
    "SMS",
    "Live_Chat"
  ],
  "waitTime": 30,
  "waitTimeUnit": "seconds",
  "sleepOnManualMessage": false,
  "sleepOnWorkflowMessage": false,
  "sleepTime": 2,
  "sleepTimeUnit": "hours",
  "emailWaitTime": 1,
  "emailWaitTimeUnit": "hours",
  "emailSettings": {},
  "actions": [
    {
      "id": "actionId123",
      "type": "triggerWorkflow"
    }
  ],
  "isPrimary": false,
  "autoPilotMaxMessages": 25,
  "goal": "Assist customers with inquiries",
  "personality": "Friendly and helpful",
  "instructions": "Provide excellent customer service",
  "fullPrompt": "string",
  "knowledgeBaseIds": [
    "kb_123",
    "kb_456"
  ],
  "knowledgeBaseTriggers": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "mode": "all",
      "knowledgeBaseIds": [
        "kb_001"
      ],
      "triggerCondition": "When the customer asks about pricing or billing",
      "priority": 2
    }
  ],
  "workingHours": {
    "enabled": false,
    "channels": [
      "SMS",
      "WhatsApp"
    ],
    "timezoneMode": "contact",
    "schedule": {
      "mon": {
        "enabled": true,
        "slots": [
          {
            "startHour": 9,
            "startMinute": 0,
            "endHour": 17,
            "endMinute": 0
          }
        ]
      },
      "tue": {
        "enabled": true,
        "slots": [
          {
            "startHour": 9,
            "startMinute": 0,
            "endHour": 17,
            "endMinute": 0
          }
        ]
      },
      "wed": {
        "enabled": true,
        "slots": [
          {
            "startHour": 9,
            "startMinute": 0,
            "endHour": 17,
            "endMinute": 0
          }
        ]
      },
      "thu": {
        "enabled": true,
        "slots": [
          {
            "startHour": 9,
            "startMinute": 0,
            "endHour": 17,
            "endMinute": 0
          }
        ]
      },
      "fri": {
        "enabled": true,
        "slots": [
          {
            "startHour": 9,
            "startMinute": 0,
            "endHour": 17,
            "endMinute": 0
          }
        ]
      },
      "sat": {
        "enabled": true,
        "slots": [
          {
            "startHour": 9,
            "startMinute": 0,
            "endHour": 17,
            "endMinute": 0
          }
        ]
      },
      "sun": {
        "enabled": true,
        "slots": [
          {
            "startHour": 9,
            "startMinute": 0,
            "endHour": 17,
            "endMinute": 0
          }
        ]
      }
    },
    "continueConversations": {
      "enabled": true,
      "inactivityTimeout": {
        "value": 15,
        "unit": "minutes"
      }
    },
    "offHoursAutoReply": {
      "enabled": false,
      "message": "Thanks for reaching out! We're currently outside of business hours.",
      "sendNotification": false,
      "notificationConfig": {
        "emailNotification": {
          "enabled": false,
          "notifyAdmins": false,
          "notifyAllUsers": false,
          "notifyAssignedUser": false,
          "notifySpecificUsers": false,
          "specificUserIds": [],
          "notifyCustomEmail": false,
          "customEmail": ""
        },
        "contactTags": []
      }
    },
    "followUp": {
      "enabled": false,
      "message": "Hi {{contact.name}}, we're here now and happy to help."
    },
    "employeeId": "wK36brxPYCOikC85FkbA",
    "createdAt": "2024-07-29T15:51:28.071Z",
    "updatedAt": "2024-07-29T15:51:28.071Z"
  }
}