{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/highlevel/json-schema/highlevel-create-employee-dto-schema.json",
  "title": "CreateEmployeeDto",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/highlevel-agents-api-openapi.yml#/components/schemas/CreateEmployeeDto",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "Name of the agent."
    },
    "businessName": {
      "type": "string",
      "description": "Name of the business the agent represents."
    },
    "mode": {
      "type": "string",
      "enum": [
        "off",
        "suggestive",
        "auto-pilot"
      ],
      "default": "off",
      "description": "Mode of operation - OFF, SUGGESTIVE, or AUTO_PILOT"
    },
    "channels": {
      "type": "array",
      "description": "Communication channels the agent can operate on",
      "items": {
        "type": "string",
        "enum": [
          "IG",
          "FB",
          "SMS",
          "WebChat",
          "WhatsApp",
          "Live_Chat"
        ]
      }
    },
    "isPrimary": {
      "type": "boolean",
      "default": false,
      "description": "Indicates if this agent is a primary agent."
    },
    "waitTime": {
      "type": "number",
      "default": 2,
      "description": "Wait time before agent responds (max 5 for minutes, 300 for seconds)"
    },
    "waitTimeUnit": {
      "type": "string",
      "enum": [
        "minutes",
        "seconds"
      ],
      "default": "seconds",
      "description": "Unit for wait time - SECONDS or MINUTES"
    },
    "sleepEnabled": {
      "type": "boolean",
      "default": false,
      "description": "Indicates if sleep functionality is enabled.",
      "deprecated": true
    },
    "sleepTime": {
      "type": "number",
      "description": "Duration of sleep period (required if sleepEnabled is true). Set to null for indefinite sleep. (max 2880 for minutes, 172800 for seconds, 48 for hours)"
    },
    "sleepTimeUnit": {
      "type": "string",
      "enum": [
        "hours",
        "minutes",
        "seconds"
      ],
      "description": "Unit of sleep time - HOURS, MINUTES, or SECONDS (required if sleepEnabled is true). Set to null for indefinite sleep."
    },
    "personality": {
      "type": "string",
      "description": "Personality traits of the agent."
    },
    "goal": {
      "type": "string",
      "description": "The goal of the agent."
    },
    "instructions": {
      "type": "string",
      "description": "Instructions for the agent."
    },
    "autoPilotMaxMessages": {
      "type": "number",
      "default": 75,
      "description": "Maximum number of messages in auto-pilot mode before requiring human intervention. (max: 100, min: 1)"
    },
    "knowledgeBaseIds": {
      "description": "Array of knowledge base IDs associated with this agent.",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "respondToImages": {
      "type": "boolean",
      "default": false,
      "description": "Allow agent to respond to images"
    },
    "respondToAudio": {
      "type": "boolean",
      "default": false,
      "description": "Allow agent to respond to audio"
    },
    "sleepOnManualMessage": {
      "type": "boolean",
      "description": "Enable sleep when a manual outbound message is sent."
    },
    "sleepOnWorkflowMessage": {
      "type": "boolean",
      "description": "Enable sleep when a workflow outbound message is sent."
    }
  },
  "required": [
    "name",
    "personality",
    "goal",
    "instructions"
  ]
}