Stream Chat
curl --request POST \
--url https://api.example.com/chat \
--header 'Content-Type: application/json' \
--data '
{
"messages": [
{}
],
"topK": 123
}
'import requests
url = "https://api.example.com/chat"
payload = {
"messages": [{}],
"topK": 123
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({messages: [{}], topK: 123})
};
fetch('https://api.example.com/chat', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/chat",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'messages' => [
[
]
],
'topK' => 123
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/chat"
payload := strings.NewReader("{\n \"messages\": [\n {}\n ],\n \"topK\": 123\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(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/chat")
.header("Content-Type", "application/json")
.body("{\n \"messages\": [\n {}\n ],\n \"topK\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/chat")
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 \"messages\": [\n {}\n ],\n \"topK\": 123\n}"
response = http.request(request)
puts response.read_bodyQuerying
Stream Chat
Stream a chat response grounded in retrieved content.
POST
/
chat
Stream Chat
curl --request POST \
--url https://api.example.com/chat \
--header 'Content-Type: application/json' \
--data '
{
"messages": [
{}
],
"topK": 123
}
'import requests
url = "https://api.example.com/chat"
payload = {
"messages": [{}],
"topK": 123
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({messages: [{}], topK: 123})
};
fetch('https://api.example.com/chat', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/chat",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'messages' => [
[
]
],
'topK' => 123
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/chat"
payload := strings.NewReader("{\n \"messages\": [\n {}\n ],\n \"topK\": 123\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(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/chat")
.header("Content-Type", "application/json")
.body("{\n \"messages\": [\n {}\n ],\n \"topK\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/chat")
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 \"messages\": [\n {}\n ],\n \"topK\": 123\n}"
response = http.request(request)
puts response.read_bodyThe generated server embeds the latest user message, retrieves relevant chunks, and supplies them to the configured chat model. The response uses a server event stream.
Set
Body
array
required
Conversation messages with a
role of user, assistant, or system and a string content.number
Maximum number of context chunks to retrieve. Defaults to the server’s
TOP_K value.Events
Each SSE frame contains a JSON object in itsdata field.
| Type | Fields | Description |
|---|---|---|
text-delta | text | The next generated text fragment. |
done | hits | Generation completed, with the retrieved context chunks. |
error | error | The stream failed after it started. |
curl --no-buffer http://localhost:8080/chat \
-H "Content-Type: application/json" \
-H "Authorization: Bearer $LARKUP_API_KEY" \
-d '{
"messages": [
{ "role": "user", "content": "How do I configure authentication?" }
],
"topK": 4
}'
event: message
data: {"type":"text-delta","text":"Configure "}
event: message
data: {"type":"text-delta","text":"SERVER_API_KEY."}
event: done
data: {"type":"done","hits":[...]}
CHAT_API_KEY and, optionally, CHAT_MODEL in the generated server environment. Custom models that use the OpenAI interface also use CHAT_BASE_URL.⌘I

