Skip to main content
POST
Start an async chat with an employee.

Authorizations

X-API-Key
string
header
required

Company API key - scoped to a specific company. Generate from the Integrations page in your dashboard.

Body

application/json

Async chat request

Request body for chatting with an employee

employeeId
string
required

ID of the employee to chat with

message
string
required

The message to send to the employee

chatId
string

ID of an existing chat to continue. Omit to start a new chat.

settings
object

Optional settings to override defaults

Response

Chat initiated

Response when starting an async chat

assistantMessageId
string

The ID of the assistant message (populated when complete)

chatId
string

The chat ID to use for polling

status
string

Status of the request (processing)

userMessageId
string

The ID of the user message