Amity Solutions
  • Announcements
  • Amity Bots Platform
    • Dashboard
      • User Journey
    • Users
      • Setup Microsoft Entra ID Integration
      • Password Policy
      • Typing animation
    • Channels
      • Connect to Facebook Page
      • Connect to LINE Official Account
      • Using Webchat SDK
      • Connet to Custom Channel
    • Audience
    • Chatbot
      • Intent
      • Entity
      • Mapper
      • Chatlogic
    • Message Template
      • Creating Message Template
      • Message Types Examples
    • Rich Menu
      • Linking Rich Menu to Channel
    • Campaign
      • Broadcast
      • ChatAds
  • Amity Bots Live Chat
    • Channels
    • Ticket
      • Ticket Management
      • Ticket Detail
      • Ticket Wrap up
      • Auto assign
    • Team Management
    • Livechat
    • Message Type
    • Livechat Dashboard
    • Audience's Profile
    • Customer Satisfaction Survey
      • Customer Satisfaction Score
    • Agent Copilot✨
  • Amity Bots Gen AI Platform
    • Dashboard
    • Assistants
      • Chat Sandbox
      • Assistant API Integration
      • Message Report
    • Fulfillments
    • Knowledge Base
      • Documents and Files (Legacy)
      • CSV File
      • Documents and Files
      • External Knowledge Base
    • AI Lab
    • Memorized Response
  • Insight
    • Journey Insight
  • Guides
    • Creating a simple chatbot
    • Setting up a LINE Rich Menu
    • How to use ChatAds
  • API Reference
  • Versioning & Upgrade Policy
Powered by GitBook
On this page
  • Message Streaming
  • Request Body
  • Response Body

Was this helpful?

  1. Amity Bots Gen AI Platform
  2. Assistants

Assistant API Integration

Get started by integrating our platform with your messaging channel via our API and the provided client secret key.

PreviousChat SandboxNextMessage Report

Last updated 9 months ago

Was this helpful?

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": []}

Assistant API Tab