v1

latestOpenAPI 3.0.22026-07-26236455.6 KB

Generate Response

Botsonic Api

Generation endpoint supporting synchronous response

post/v1/botsonic/generate

Headers

tokenstring required

Request body

input_textstring required

User question for bot

chat_idstring uuid required

chat_id for given chat

sourcestring

Sources to refer

starter_question_idstring uuid

starter question id

is_business_api_requestboolean

is_integration_requestboolean

integration_user_identifierstring

integration user unique identifier

user_unique_identifierstring

Can be passed to store some additional user data in inbox

response_type'text' | 'html' | 'markdown' | 'mrkdwn'

An enumeration.

chat_user_idstring

chat_user_id for given chat , this links with old user data

extra_metadataobject

extra metadata for given chat(integration specific)

full_historyboolean

if true, will return full history of chat till now

message_idstring uuid

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

timeoutnumber

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

Example request

{
  "chat_user_id": "5eb7cf5a86d9755df3a6c593"
}

Response

Successful Response

answerstring required

message_idstring uuid

sourcesobject[]

generated_imagesstring[]

follow_up_questionsstring[]

human_handoff_statusboolean

chat_endedboolean

end_chat_feedbackstring

All 23 operations