Assistant chat (SSE)
curl --request POST \
--url http://localhost:8080/api/v1/assistant/chat \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"messages": [
{
"content": "<string>"
}
],
"maxIterations": 50,
"context": {},
"attachments": [
{
"attachmentId": "<string>"
}
]
}
'import requests
url = "http://localhost:8080/api/v1/assistant/chat"
payload = {
"messages": [{ "content": "<string>" }],
"maxIterations": 50,
"context": {},
"attachments": [{ "attachmentId": "<string>" }]
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
messages: [{content: '<string>'}],
maxIterations: 50,
context: {},
attachments: [{attachmentId: '<string>'}]
})
};
fetch('http://localhost:8080/api/v1/assistant/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_PORT => "8080",
CURLOPT_URL => "http://localhost:8080/api/v1/assistant/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' => [
[
'content' => '<string>'
]
],
'maxIterations' => 50,
'context' => [
],
'attachments' => [
[
'attachmentId' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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 := "http://localhost:8080/api/v1/assistant/chat"
payload := strings.NewReader("{\n \"messages\": [\n {\n \"content\": \"<string>\"\n }\n ],\n \"maxIterations\": 50,\n \"context\": {},\n \"attachments\": [\n {\n \"attachmentId\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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("http://localhost:8080/api/v1/assistant/chat")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"messages\": [\n {\n \"content\": \"<string>\"\n }\n ],\n \"maxIterations\": 50,\n \"context\": {},\n \"attachments\": [\n {\n \"attachmentId\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8080/api/v1/assistant/chat")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"messages\": [\n {\n \"content\": \"<string>\"\n }\n ],\n \"maxIterations\": 50,\n \"context\": {},\n \"attachments\": [\n {\n \"attachmentId\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body"<string>"Assistant
Assistant chat (SSE)
Runs the build-mode Assistant agent loop and streams agent-loop events (text deltas, tool calls, tool results, errors) as Server-Sent Events. The client cancels by disconnecting. Attachments reference files previously staged via /assistant/attachment.
POST
/
api
/
v1
/
assistant
/
chat
Assistant chat (SSE)
curl --request POST \
--url http://localhost:8080/api/v1/assistant/chat \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"messages": [
{
"content": "<string>"
}
],
"maxIterations": 50,
"context": {},
"attachments": [
{
"attachmentId": "<string>"
}
]
}
'import requests
url = "http://localhost:8080/api/v1/assistant/chat"
payload = {
"messages": [{ "content": "<string>" }],
"maxIterations": 50,
"context": {},
"attachments": [{ "attachmentId": "<string>" }]
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
messages: [{content: '<string>'}],
maxIterations: 50,
context: {},
attachments: [{attachmentId: '<string>'}]
})
};
fetch('http://localhost:8080/api/v1/assistant/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_PORT => "8080",
CURLOPT_URL => "http://localhost:8080/api/v1/assistant/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' => [
[
'content' => '<string>'
]
],
'maxIterations' => 50,
'context' => [
],
'attachments' => [
[
'attachmentId' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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 := "http://localhost:8080/api/v1/assistant/chat"
payload := strings.NewReader("{\n \"messages\": [\n {\n \"content\": \"<string>\"\n }\n ],\n \"maxIterations\": 50,\n \"context\": {},\n \"attachments\": [\n {\n \"attachmentId\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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("http://localhost:8080/api/v1/assistant/chat")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"messages\": [\n {\n \"content\": \"<string>\"\n }\n ],\n \"maxIterations\": 50,\n \"context\": {},\n \"attachments\": [\n {\n \"attachmentId\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8080/api/v1/assistant/chat")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"messages\": [\n {\n \"content\": \"<string>\"\n }\n ],\n \"maxIterations\": 50,\n \"context\": {},\n \"attachments\": [\n {\n \"attachmentId\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body"<string>"Authorizations
Optional API key for authentication (enabled via application.yaml)
Body
application/json
Show child attributes
Show child attributes
Maximum agent-loop iterations (LLM + tool-call rounds) before the loop stops
Optional endpoint-specific context object (see each chat endpoint's description)
Handles of files staged via /assistant/attachment for this turn
Show child attributes
Show child attributes
Response
200 - text/event-stream
Server-Sent Events stream of agent-loop events
The response is of type string.
⌘I
