Skip to main content
POST
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

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 response

Chat completion response from employee

model
string

Model used for the response

response
string

AI-generated response

settings
object

Applied settings for the completion