Generate suggestions

curl --request POST \
  --url https://api.sandbox.asapp.com/autocompose/v1/conversations/{conversationId}/suggestions \
  --header 'Content-Type: application/json' \
  --header 'asapp-api-id: <api-key>' \
  --header 'asapp-api-secret: <api-key>' \
  --data '
{
  "query": "Hello, how can",
  "message": {
    "text": "Hello, I would like to upgrade my internet plan to GOLD.",
    "sender": {
      "role": "customer",
      "externalId": "customer-x"
    },
    "timestamp": "2023-06-01T19:16:55.706Z"
  }
}
'

{
  "id": "<string>",
  "message": {
    "id": "01BX5ZZKBKACTAV9WEVGEMMVS1"
  },
  "suggestions": [
    {
      "text": "Hello John, how can I help you?",
      "templateText": "Hello {NAME}, how can I help you?",
      "title": "Greeting"
    }
  ],
  "phraseCompletion": {
    "text": "Hello, how can I help you?"
  },
  "autopilotMessage": {
    "text": "Hello John, how can I help you?",
    "templateText": "Hello {NAME}, how can I help you?",
    "title": "Greeting",
    "delaySeconds": 5,
    "triggerAfterSeconds": 0
  }
}

POST

autocompose

conversations

{conversationId}

suggestions

Generate suggestions

curl --request POST \
  --url https://api.sandbox.asapp.com/autocompose/v1/conversations/{conversationId}/suggestions \
  --header 'Content-Type: application/json' \
  --header 'asapp-api-id: <api-key>' \
  --header 'asapp-api-secret: <api-key>' \
  --data '
{
  "query": "Hello, how can",
  "message": {
    "text": "Hello, I would like to upgrade my internet plan to GOLD.",
    "sender": {
      "role": "customer",
      "externalId": "customer-x"
    },
    "timestamp": "2023-06-01T19:16:55.706Z"
  }
}
'

{
  "id": "<string>",
  "message": {
    "id": "01BX5ZZKBKACTAV9WEVGEMMVS1"
  },
  "suggestions": [
    {
      "text": "Hello John, how can I help you?",
      "templateText": "Hello {NAME}, how can I help you?",
      "title": "Greeting"
    }
  ],
  "phraseCompletion": {
    "text": "Hello, how can I help you?"
  },
  "autopilotMessage": {
    "text": "Hello John, how can I help you?",
    "templateText": "Hello {NAME}, how can I help you?",
    "title": "Greeting",
    "delaySeconds": 5,
    "triggerAfterSeconds": 0
  }
}

Authorizations

asapp-api-id

string

header

required

asapp-api-secret

string

header

required

Path Parameters

conversationId

string

required

The identifier for a conversation.

Body

application/json

The parameters for getting suggestions for the next agent message.

A suggestions request with an optional message to add to the conversation

query

string

text the agent has already entered into the composer

message

object

Represents a single message within a conversation.

Show child attributes

message.text

string

required

The content of the message.

Minimum string length: 1

message.sender

object

required

Information about the participant who sent the message.

Show child attributes

message.sender.role

enum<string>

required

The role of the participant in the conversation.

Available options:

agent,

customer,

system

message.sender.externalId

string

required

The unique identifier for the participant in your external system. This should be consistent across all interactions for the same individual.

message.timestamp

string<date-time>

required

The time when the message was sent. Include the timezone, otherwise UTC will be assumed.

Example:

{
  "text": "Hello, I would like to upgrade my internet plan to GOLD.",
  "sender": { "role": "agent", "externalId": 123 },
  "timestamp": "2021-11-23T12:13:14.555Z"
}

Response

Successfully fetched suggestions for the conversation

Suggestions for next agent message

string

ID for the suggestions that were returned (to be used in analytics events)

message

object

Response for messages

Show child attributes

message.id

string

Message ID to be used for analytics

Example:

{ "id": "01BX5ZZKBKACTAV9WEVGEMMVS1" }

suggestions

object[]

Show child attributes

suggestions.text

string

Suggestion text for the agent

Example:

"Hello John, how can I help you?"

suggestions.templateText

string

Suggestion text with placeholders for metadata instead of the values filled in

Example:

"Hello {NAME}, how can I help you?"

suggestions.title

string

The title of the response

Example:

"Greeting"

phraseCompletion

object

Completion of the phrase the agent is currently typing, to be displayed inline in the composer

Show child attributes

phraseCompletion.text

string

Phrase completion text for the agent (this may be empty if the model does not have a confident prediction for how to complete the message)

Example:

"Hello, how can I help you?"

autopilotMessage

object

Recommended message for the agent to autopilot send.

Show child attributes

autopilotMessage.text

string

Text of the message

Example:

"Hello John, how can I help you?"

autopilotMessage.templateText

string

Text of the message with placeholders for metadata instead of the values filled in

Example:

"Hello {NAME}, how can I help you?"

autopilotMessage.title

string

The title of the message

Example:

"Greeting"

autopilotMessage.delaySeconds

integer

Delay before the message is sent to the customer, during which a preview of the message is shown to the agent and they can choose to cancel it

Example:

5

autopilotMessage.triggerAfterSeconds

integer

Delay before showing the preview and starting the countdown to send the message

Example:

0

Get Twilio media stream url Evaluate profanity

⌘I

ASAPP APIs

Authorizations

Path Parameters

Body

Response