---
title: "Get Streaming Response With Custom Settings"
method: POST
path: "/api/chat/get-streaming-response-with-custom-settings"
tags: ["Chat"]
---

# Get Streaming Response With Custom Settings

`POST /api/chat/get-streaming-response-with-custom-settings`

Get streaming response with custom settings.

## Query parameters

- `is_get_suggest_question` string, nullable — Specify whether to get suggested questions.

## Request body

- StreamingWithCustomSettingsSchema — Schema for streaming with custom settings.
  - `bot_id` string, uuid, required — Unique identifier for the associated bot.
  - `message` string, required — Content of the message.
  - `chat_history` ChatHistorySchema[], required — List of chat history entries.
    - `sender_type` string, required — Type of the message sender.
    - `content` string, required — Content of the message.
  - `custom_prompt` string, nullable — Optional custom prompt for the GPT model.
  - `gpt_model_name` string, nullable — Optional GPT model name.
  - `temperature` number, nullable — Optional temperature setting.
  - `rules` string[], nullable — Optional list of rules.
  - `is_enable_citation` boolean, nullable — Optional flag for enabling citation.

## Response `200`

Successful Response

- string

## Other responses

- `422` — Validation Error

## Changes

> 3 revisions in range; 1 not diffed.

- **2023-11-13** `ac1f1ab68fcb` — 1 breaking, 7 info
  - the request property `chat_history` became required
  - the `chat_history` request property default value `` was removed
  - the `rules` request property default value `` was removed
  - request property `custom_prompt` list-of-types was widened by adding types `null` to media type `application/json`
  - …4 more
- **2023-11-08** `dbd91277da05` — 5 breaking, 2 warning, 6 info
  - request property `custom_prompt` list-of-types was narrowed by removing types `null` from media type `application/json`
  - request property `gpt_model_name` list-of-types was narrowed by removing types `null` from media type `application/json`
  - request property `rules` list-of-types was narrowed by removing types `null` from media type `application/json`
  - request property `temperature` list-of-types was narrowed by removing types `null` from media type `application/json`
  - …9 more

[Change history](https://skmtc.dev/chat-fly/apis/chatfly-backend-application/changes/api/chat/get-streaming-response-with-custom-settings/post.md)

---

[API](https://skmtc.dev/chat-fly/apis/chatfly-backend-application.md) · [All operations](https://skmtc.dev/chat-fly/apis/chatfly-backend-application/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/chat-fly/chatfly-backend-application/revisions/cbb37496f138/schema)