v1

latestOpenAPI 3.0.0Proprietary2026-08-062711471.0 MB

Agent Builder

Get livechat settings

Returns livechat channel settings for an agent.

get/public/v1/agents/{agentId}/settings/livechat

Path parameters

agentIdstring required

Example:uuid-xxxx-xxxx

Response

Channel settings

splitMessagesboolean required

splitCharacterLimitinteger required

closeAfternumber nullable required

timeUnit'MINUTES' | 'HOURS' nullable required

conversationClose'NEVER' | 'AUTOMATICALLY' | 'DYNAMICALLY' required

collectFeedbackboolean required

feedbackVisibility'ON_HOVER' | 'ALWAYS_VISIBLE' required

feedbackTextstring nullable required

collectFeedbackReasonboolean required

includeOtherReasonboolean required

openFeedbackTextstring nullable required

enableDocumentProcessingboolean

enableImageProcessingboolean

enableIdleboolean required

Example response

{
  "splitCharacterLimit": 1,
  "closeAfter": 1,
  "timeUnit": "MINUTES",
  "conversationClose": "NEVER",
  "feedbackVisibility": "ON_HOVER",
  "feedbackText": "example",
  "openFeedbackText": "example",
  "feedbackReasons": [
    {
      "id": 1,
      "reason": "example",
      "order": 1
    }
  ],
  "idleSettings": {
    "id": 1,
    "after": 1,
    "timeUnit": "MINUTES",
    "resetsLimit": 1
  }
}