# Streaming Chat

POST /api/v1/qllm/chat-stream/{session_id}/
Content-Type: application/json

Sends a message to a chat session and streams the response word by word.

Reference: https://docs.aisquare.studio/api-reference/ai-square-studio-api/qllm/chat-stream-create

## OpenAPI Specification

```yaml
openapi: 3.1.0
info:
  title: AISquare Studio API
  version: 1.0.0
paths:
  /api/v1/qllm/chat-stream/{session_id}/:
    post:
      operationId: chat-stream-create
      summary: Streaming Chat
      description: Sends a message to a chat session and streams the response word by word.
      tags:
        - subpackage_qllm
      parameters:
        - name: session_id
          in: path
          description: Chat session ID
          required: true
          schema:
            type: integer
      responses:
        '200':
          description: >-
            Streaming response with Server-Sent Events (SSE) format. Each chunk
            is a JSON object with different types: 'start' (session started),
            'token' (word/token), 'complete' (response finished), 'metadata'
            (message info, suggestions, title), 'end' (stream finished), 'error'
            (error occurred).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/qllm_chatStreamCreate_Response_200'
        '400':
          description: Invalid input
          content:
            application/json:
              schema:
                description: Any type
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                description: Any type
        '404':
          description: Chat session not found
          content:
            application/json:
              schema:
                description: Any type
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StreamingChatRequest'
components:
  schemas:
    StreamingChatRequest:
      type: object
      properties:
        prompt:
          type: string
          description: The user's message.
      required:
        - prompt
      title: StreamingChatRequest
    qllm_chatStreamCreate_Response_200:
      type: object
      properties: {}
      description: Empty response body
      title: qllm_chatStreamCreate_Response_200

```

## SDK Code Examples

```python
import requests

url = "https://api.example.com/api/v1/qllm/chat-stream/1/"

payload = { "prompt": "Can you explain the concept of quantum computing in simple terms?" }
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.example.com/api/v1/qllm/chat-stream/1/';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: '{"prompt":"Can you explain the concept of quantum computing in simple terms?"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/api/v1/qllm/chat-stream/1/"

	payload := strings.NewReader("{\n  \"prompt\": \"Can you explain the concept of quantum computing in simple terms?\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v1/qllm/chat-stream/1/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"prompt\": \"Can you explain the concept of quantum computing in simple terms?\"\n}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api.example.com/api/v1/qllm/chat-stream/1/")
  .header("Content-Type", "application/json")
  .body("{\n  \"prompt\": \"Can you explain the concept of quantum computing in simple terms?\"\n}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.example.com/api/v1/qllm/chat-stream/1/', [
  'body' => '{
  "prompt": "Can you explain the concept of quantum computing in simple terms?"
}',
  'headers' => [
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.example.com/api/v1/qllm/chat-stream/1/");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"prompt\": \"Can you explain the concept of quantum computing in simple terms?\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Content-Type": "application/json"]
let parameters = ["prompt": "Can you explain the concept of quantum computing in simple terms?"] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.example.com/api/v1/qllm/chat-stream/1/")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```