POST
/
api
/
chat
/
get-streaming-response-with-custom-settings
curl --request POST \
  --url https://backend.chatfly.co/api/chat/get-streaming-response-with-custom-settings \
  --header 'Content-Type: application/json' \
  --data '{
  "bot_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "message": "<string>",
  "chat_history": [
    {
      "sender_type": "<string>",
      "content": "<string>"
    }
  ],
  "custom_prompt": "<string>",
  "gpt_model_name": "<string>",
  "temperature": 123,
  "rules": [
    "<string>"
  ],
  "is_enable_citation": true
}'
"<string>"

Query Parameters

​
is_get_suggest_question
string | null

Specify whether to get suggested questions.

Body

application/json

Schema for streaming with custom settings.

​
bot_id
string
required

Unique identifier for the associated bot.

​
message
string
required

Content of the message.

​
chat_history
object[]
required

List of chat history entries.

​
custom_prompt
string | null
default:
I want you to act as an assistant to a customer support agent by writing email responses. I will provide the customer inquiry or issue, and your task is to compose an appropriate, professional, and helpful response. You should not include additional instructions, questions, or explanations in your response. Only the main body of the email needs to be written.

Optional custom prompt for the GPT model.

​
gpt_model_name
string | null
default:
gpt-3.5-turbo-16k

Optional GPT model name.

​
temperature
number | null
default:
0

Optional temperature setting.

​
rules
string[] | null

Optional list of rules.

​
is_enable_citation
boolean | null
default:
false

Optional flag for enabling citation.

Response

200
application/json
Successful Response

The response is of type string.

Was this page helpful?

Suggest editsRaise issue
Get Streaming Response With Chat HistoryGet Conversations History