API Reference

Create a BizAIChatMessage

post
https://api.vcita.biz/v3/ai/bizai_chat_messages

Overview

Create a new BizAIChatMessage in a BizAIChat thread and get an AI response Available for Staff Tokens.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
required

Unique identifier of the BizAIChat

Body Params
string
enum
required

The type of message sent to the bot (free text or a saved prompt template). A saved prompt can include reusable instructions that can be retrieved from BizAI for advanced functionality.

Allowed:
content
required

An object representing the content sent to the bot. Each prompt type must have its own object ("Text Content Object" for "text" and "Prompt Content Object" for "prompt"). Note: content must be an object, not a string.

boolean
Defaults to true

Stream response option. If true, the response will be streamed to the client. If false, the response will be sent as a single message

Response

Updated 3 months ago

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago