Skip to main content
GET
/
v2
/
Pearl
/
{pearlId}
/
Settings
Get Pearl Settings
curl --request GET \
  --url https://api.nlpearl.ai/v2/Pearl/{pearlId}/Settings \
  --header 'Authorization: Bearer <token>'
{
  "name": "<string>",
  "type": 123,
  "pearl": {
    "agents": [
      {
        "name": "<string>",
        "voiceId": "<string>"
      }
    ],
    "agentPersonality": "<string>",
    "timeZone": "<string>",
    "modelType": 123,
    "companyName": "<string>",
    "companyDescription": "<string>",
    "knowledgeBase": "<string>",
    "memory": true,
    "speechRecognitionKeywords": [
      {
        "word": "<string>",
        "pronunciations": [
          "<string>"
        ]
      }
    ],
    "openingSentence": "<string>",
    "flowScript": "<string>",
    "transferCallSettings": [
      {
        "transferCallPhoneNumber": "<string>",
        "triggerDescription": "<string>",
        "warmTransferMessage": "<string>"
      }
    ],
    "smsSettings": [
      {
        "body": "<string>",
        "triggerDescription": "<string>"
      }
    ],
    "emailSettings": [
      {
        "subject": "<string>",
        "body": "<string>",
        "triggerDescription": "<string>",
        "smtpSettings": {
          "id": "<string>",
          "provider": 123,
          "smtpServer": "<string>",
          "port": 123,
          "enableSsl": true,
          "senderEmail": "<string>",
          "senderPassword": "<string>",
          "displayName": "<string>"
        }
      }
    ],
    "apiSettings": [
      {
        "name": "<string>",
        "method": 123,
        "endpointUrl": "<string>",
        "body": [
          {
            "key": "<string>",
            "variableId": "<string>",
            "type": 123,
            "value": "<string>",
            "required": true
          }
        ],
        "headers": {},
        "triggerDescription": "<string>",
        "description": "<string>"
      }
    ],
    "successDescription": "<string>",
    "indicatorTags": [
      {
        "id": "<string>",
        "name": "<string>",
        "description": "<string>",
        "color": 123
      }
    ],
    "notifications": [
      {
        "apiSettings": {
          "name": "<string>",
          "method": 123,
          "endpointUrl": "<string>",
          "body": [
            {
              "key": "<string>",
              "variableId": "<string>",
              "type": 123,
              "value": "<string>",
              "required": true
            }
          ],
          "headers": {},
          "triggerDescription": "<string>",
          "description": "<string>"
        },
        "emailTemplate": {
          "to": [
            "<string>"
          ],
          "cc": [
            "<string>"
          ],
          "subject": "<string>",
          "body": "<string>",
          "triggerDescription": "<string>",
          "smtpSettings": {
            "id": "<string>",
            "provider": 123,
            "smtpServer": "<string>",
            "port": 123,
            "enableSsl": true,
            "senderEmail": "<string>",
            "senderPassword": "<string>",
            "displayName": "<string>"
          }
        },
        "indicatorTagsIds": [
          "<string>"
        ]
      }
    ]
  },
  "variables": [
    {
      "id": "<string>",
      "name": "<string>",
      "group": 123,
      "type": 123,
      "isList": true,
      "description": "<string>",
      "value": "<string>",
      "options": [
        {
          "value": "<string>",
          "code": "<string>"
        }
      ],
      "required": true,
      "readOnly": true
    }
  ],
  "inbound": {
    "phoneNumberId": "<string>",
    "waitingSentence": "<string>",
    "totalAgents": 123,
    "recordingOptions": true,
    "isStopRecordingAfterTransferCall": true,
    "transcriptOptions": 123,
    "callWebhookUrl": "<string>",
    "isSayQueueDetails": true
  },
  "outbound": {
    "phoneNumberId": "<string>",
    "totalAgents": 123,
    "recordingTrack": 123,
    "isStopRecordingAfterTransferCall": true,
    "transcriptOptions": 123,
    "budgetTotal": 123,
    "timeZone": "<string>",
    "maximumCallAttempts": 123,
    "minimumRetryIntervalHours": 123,
    "ringDuration": 123,
    "callTimeout": 123,
    "voiceMail": "<string>",
    "bypassIVRInstruction": "<string>",
    "callingHours": [
      {
        "day": 123,
        "start": "<string>",
        "end": "<string>"
      }
    ],
    "callWebhookUrl": "<string>",
    "leadWebhookUrl": "<string>"
  }
}

Documentation Index

Fetch the complete documentation index at: https://developers.nlpearl.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Specify the authorization token.

For more information, check out the Authorization Guide.

Path Parameters

​
pearlId
string
required

The unique identifier of the Pearl.

Response

The settings for the specified Pearl.

​
name
string | null

The name of the Pearl.

​
type
integer<int32>

Defines the type of activity of the pearl.

1 - Inbound

2 - Outbound

​
pearl
object

Conversation flow and agent behavior configuration for the Pearl.

This field is populated only if the Pearl was created via the API. If the Pearl was created through the platform interface, this field will be empty.

​
variables
object[] | null

Variables defined for the Pearl and used by the agent during conversations.

This field is populated only if the Pearl was created via the API. If the Pearl was created through the platform interface, this field will be empty.

​
inbound
object

Inbound settings for the Pearl. Present only when the Pearl type is inbound.

​
outbound
object

Outbound settings for the Pearl. Present only when the Pearl type is outbound.