Skip to main content
POST
Send Context to Conversation

Authorizations

x-api-key
string
header
required

Your Beyond Presence API Key.

Path Parameters

id
string
required

Conversation ID.

Body

application/json

Request body to send context to the agent of an ongoing conversation.

text
string
required

Context for the agent, such as what the user is looking at. It stays in the conversation, so later answers use it too.

Required string length: 1 - 3000
Pattern: ^[^\x00-\x08\x0b\x0c\x0e-\x1f\x7f]*$
Example:

"The user is now on page 3: Retail Installment Contract."

respond
boolean
default:true

Whether the agent responds to the context right away, interrupting what it is saying. Otherwise it only uses the context when it next replies.

Response

Successful Response