Assistant API Integration

Assistant API Tab

The system will display the Secret Key for the assistant, which you will need for authorization with the BOTs+ Messaging API. You can select your preferred language and add the provided code to your project.

Message Streaming

Enhance the messaging API to support streaming answers. (This feature is currently available only via the API.)

Request Body

• Add ‘stream’ as a boolean, set TRUE to enable streaming

{
  ...,
  "stream": true
}

Response Body

Here’s the example of response body

/// completion in progress
data: {"__status": "active", "content": "Hello"}
data: {"__status": "active", "content": "Hello! How may"}

// once processing has finished
data: {"__status": "finished", "answer": "Hello! How may I help you?" , "inspection": {...}, searchResults: {...}}

// if there are any errors
data: {"__error", "name": "SampleException", "code": 400000, "status": 400, "message": "error message", "errors": []}