Skip to main content
POST
/
v2
/
Pearl
Create Pearl
curl --request POST \
  --url https://api.nlpearl.ai/v2/Pearl \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "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>"
      }
    ],
    "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>"
        },
        "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>"
        }
      ]
    }
  ],
  "inbound": {
    "phoneNumberId": "<string>",
    "totalAgents": 123,
    "recordingOptions": true,
    "isStopRecordingAfterTransferCall": true,
    "transcriptOptions": 123,
    "callWebhookUrl": "<string>",
    "waitingSentence": "<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>",
    "callingHours": [
      {
        "day": 123,
        "start": "<string>",
        "end": "<string>"
      }
    ],
    "callWebhookUrl": "<string>",
    "leadWebhookUrl": "<string>"
  }
}
'
"<string>"

Authorizations

Authorization
string
header
required

Specify the authorization token.

For more information, check out the Authorization Guide.

Body

The Pearl flow configuration to create.

name
string | null

The name of the Pearl.

pearl
object

Conversation flow and agent behavior configuration for the Pearl.

variables
object[] | null

Variables that can be defined, stored, and used by the agent during conversations. For details on variable groups and how to use variables in supported fields, see: Flow Variables

inbound
object

Inbound settings for the Pearl. Required when creating an inbound Pearl. Must not be provided together with Outbound.

outbound
object

Outbound settings for the Pearl. Required when creating an outbound Pearl. Must not be provided together with Inbound.

Response

The ID of the newly created Pearl.

The response is of type string.