Chat integrations/REST API

Get batch chat message endpoint

Concepts

  • You can send chat messages to your AI agents over the REST API.
  • Complex chat messages requests can take a long time, and the message endpoint could time-out because of this.
  • The batch chat message returns a batchJobId, which you can then poll the get batch message endpoint with to check when the results are ready.

The get batch chat message endpoint

Go to the agent's project page to get your:

  • User profile id

Use the batchJobId value returned from the batch message endpoint.

Send a POST request to https://server-name/api/v1/chat/batch-message/[batchJobId] with the following JSON in the body:

NameTypeRequiredDescription
userProfileIdstringyesThe internal user profile id.

A chatSessionId is returned and can be used to reference the session in future message calls.

There is usually only one message returned, since you don't need to resend any chat history (the platform handles that). For example:

[
  {
    type: '',
    text: 'Hi'
  }
]

On this page