POpoll-the-people
Deployment Settings

Get deployment settings.

Changed on

Returns all deployment section configurations (embed, live_chat, ai_assistant, instant_viewer, sge) for an agent. Missing settings are returned with their default values.

get/api/v1/projects/{projectId}/deployment

Request

Path parameters

projectIdinteger required

The unique identifier of the agent.

Response

Deployment settings for all sections of an agent

status'error' | 'success'

The status of the response

Example response

{
  "status": "success",
  "data": {
    "embed": {
      "width": 100,
      "widthUnit": "%",
      "height": 500,
      "heightUnit": "px",
      "heightType": "fixed",
      "mobileFontSize": true
    },
    "live_chat": {
      "width": 100,
      "widthUnit": "%",
      "height": 500,
      "heightUnit": "px",
      "heightType": "fixed",
      "mobileFontSize": true,
      "position": "right",
      "chatbotType": "compact",
      "iconSize": "small",
      "autoStartConversation": true
    },
    "ai_assistant": {
      "mobileFontSize": true,
      "defaultButtonText": "Ask AI",
      "defaultButtonColor": "#7367f0",
      "isUsingDefaultButton": true,
      "chatbotType": "compact"
    },
    "instant_viewer": {
      "mobileFontSize": true,
      "defaultButtonText": "Ask AI",
      "defaultButtonColor": "#7367f0",
      "isUsingDefaultButton": true,
      "chatbotType": "window"
    },
    "sge": {
      "mobileFontSize": true,
      "height": 500,
      "heightUnit": "px",
      "heightType": "fixed",
      "customSearchParameter": "q"
    }
  }
}

Changes