Generate Sync Or Streaming Response

post https://api.botsonic.ai/v1/business/botsonic

Generation endpoint supporting synchronous response as well as streaming based on your usecase.

Query Params

stream

boolean

Defaults to false

Set to true if you want to stream data otherwise, use false for standard data retrieval.

Body Params

input_text

string

required

length ≥ 1

User question for bot

chat_id

string

required

chat_id for given chat

source

string

Sources to refer

starter_question_id

string

starter question id

is_business_api_request

boolean

Defaults to false

is_integration_request

boolean

Defaults to false

generation_source_name

Defaults to api

integration_user_identifier

string

integration user unique identifier

user_unique_identifier

string

Can be passed to store some additional user data in inbox

chat_history

array of objects

Previous chat history for reference

Chat History

response_type

string

Defaults to text

An enumeration.

chat_user_id

string

chat_user_id for given chat , this links with old user data

extra_metadata

object

extra metadata for given chat(integration specific)

full_history

boolean

if true, will return full history of chat till now

message_id

string

message id of any chat message to be used to resolve handoff

hands_off_metadata

object

metadata for handoff

timeout

number

The timeout duration, measured in seconds, represents the maximum period that the endpoint will maintain the connection open to generate a response before terminating the request

Responses

Language

Credentials

Header


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api.botsonic.ai/v1/business/botsonic \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful Response

422Validation Error