Stream Chat With Agent (Inference v3)
curl --request POST \
--url https://agent-prod.studio.lyzr.ai/v3/inference/stream/ \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"user_id": "default_user",
"agent_id": "string",
"session_id": "string",
"message": "string",
"system_prompt_variables": {},
"filter_variables": {},
"features": [
{
"additionalProp1": {}
}
]
}
'import requests
url = "https://agent-prod.studio.lyzr.ai/v3/inference/stream/"
payload = {
"user_id": "default_user",
"agent_id": "string",
"session_id": "string",
"message": "string",
"system_prompt_variables": {},
"filter_variables": {},
"features": [{ "additionalProp1": {} }]
}
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({
user_id: 'default_user',
agent_id: 'string',
session_id: 'string',
message: 'string',
system_prompt_variables: {},
filter_variables: {},
features: [{additionalProp1: {}}]
})
};
fetch('https://agent-prod.studio.lyzr.ai/v3/inference/stream/', 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://agent-prod.studio.lyzr.ai/v3/inference/stream/",
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([
'user_id' => 'default_user',
'agent_id' => 'string',
'session_id' => 'string',
'message' => 'string',
'system_prompt_variables' => [
],
'filter_variables' => [
],
'features' => [
[
'additionalProp1' => [
]
]
]
]),
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 := "https://agent-prod.studio.lyzr.ai/v3/inference/stream/"
payload := strings.NewReader("{\n \"user_id\": \"default_user\",\n \"agent_id\": \"string\",\n \"session_id\": \"string\",\n \"message\": \"string\",\n \"system_prompt_variables\": {},\n \"filter_variables\": {},\n \"features\": [\n {\n \"additionalProp1\": {}\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("https://agent-prod.studio.lyzr.ai/v3/inference/stream/")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"user_id\": \"default_user\",\n \"agent_id\": \"string\",\n \"session_id\": \"string\",\n \"message\": \"string\",\n \"system_prompt_variables\": {},\n \"filter_variables\": {},\n \"features\": [\n {\n \"additionalProp1\": {}\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://agent-prod.studio.lyzr.ai/v3/inference/stream/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"user_id\": \"default_user\",\n \"agent_id\": \"string\",\n \"session_id\": \"string\",\n \"message\": \"string\",\n \"system_prompt_variables\": {},\n \"filter_variables\": {},\n \"features\": [\n {\n \"additionalProp1\": {}\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"response": "Streamed response will appear here"
}Agents
Stream Chat
Start a streaming chat interaction with an agent using the v3 inference stream endpoint.
POST
/
inference
/
stream
/
Stream Chat With Agent (Inference v3)
curl --request POST \
--url https://agent-prod.studio.lyzr.ai/v3/inference/stream/ \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"user_id": "default_user",
"agent_id": "string",
"session_id": "string",
"message": "string",
"system_prompt_variables": {},
"filter_variables": {},
"features": [
{
"additionalProp1": {}
}
]
}
'import requests
url = "https://agent-prod.studio.lyzr.ai/v3/inference/stream/"
payload = {
"user_id": "default_user",
"agent_id": "string",
"session_id": "string",
"message": "string",
"system_prompt_variables": {},
"filter_variables": {},
"features": [{ "additionalProp1": {} }]
}
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({
user_id: 'default_user',
agent_id: 'string',
session_id: 'string',
message: 'string',
system_prompt_variables: {},
filter_variables: {},
features: [{additionalProp1: {}}]
})
};
fetch('https://agent-prod.studio.lyzr.ai/v3/inference/stream/', 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://agent-prod.studio.lyzr.ai/v3/inference/stream/",
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([
'user_id' => 'default_user',
'agent_id' => 'string',
'session_id' => 'string',
'message' => 'string',
'system_prompt_variables' => [
],
'filter_variables' => [
],
'features' => [
[
'additionalProp1' => [
]
]
]
]),
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 := "https://agent-prod.studio.lyzr.ai/v3/inference/stream/"
payload := strings.NewReader("{\n \"user_id\": \"default_user\",\n \"agent_id\": \"string\",\n \"session_id\": \"string\",\n \"message\": \"string\",\n \"system_prompt_variables\": {},\n \"filter_variables\": {},\n \"features\": [\n {\n \"additionalProp1\": {}\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("https://agent-prod.studio.lyzr.ai/v3/inference/stream/")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"user_id\": \"default_user\",\n \"agent_id\": \"string\",\n \"session_id\": \"string\",\n \"message\": \"string\",\n \"system_prompt_variables\": {},\n \"filter_variables\": {},\n \"features\": [\n {\n \"additionalProp1\": {}\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://agent-prod.studio.lyzr.ai/v3/inference/stream/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"user_id\": \"default_user\",\n \"agent_id\": \"string\",\n \"session_id\": \"string\",\n \"message\": \"string\",\n \"system_prompt_variables\": {},\n \"filter_variables\": {},\n \"features\": [\n {\n \"additionalProp1\": {}\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"response": "Streamed response will appear here"
}Authorizations
Body
application/json
Example:
"default_user"
Example:
"string"
Example:
"string"
Example:
"string"
Optional dynamic variables to fill in the system prompt
Example:
{}
Optional filter values for prompt logic
Example:
{}
Optional features to modify behavior
Response
Streaming started successfully
Example:
"Streamed response will appear here"
⌘I