Skip to main content
POST
Send Message
Send a message to the business analyst and receive an analyzed response.

Request

string
required
The message to analyze
string
required
Unique identifier for the user in your system
array
Previous messages in the conversation
string
ID of an existing conversation to continue
string[]
List of specific integrations to use
boolean
default:"true"
Whether to use all available integrations
string
default:"business_analyst"
Mode of operation (‘chat’ or ‘business_analyst’)
string
ID of a specific agent to use
boolean
default:"false"
Whether to store conversation history
boolean
default:"false"
Whether to use passthrough integrations

Response

string
The analyzed response to the message
string
The agent’s thought process
array
Actions taken by the agent
string
Suggested follow-up question
string
Reasoning behind the analysis
string
ID of the conversation
number
Unix timestamp of the response

Example

Error Codes

object
Authentication error
object
Permission error
object
Rate limit exceeded

Notes

  • The conversation history is automatically stored unless privacyMode is enabled
  • When useAllIntegrations is true, the agent will use all available integrations for the user/organization
  • The mode parameter determines how the message is processed:
    • business_analyst: Full analysis with integrations
    • chat: Simple chat response without integration data
  • Rate limits apply based on your plan (see Rate Limiting)