Skip to main content
POST
/
inference
/
chat
/
Chat With Agent (Inference v3)
curl --request POST \
  --url https://agent-prod.studio.lyzr.ai/v3/inference/chat/ \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "user_id": "rohithchandra1952@gmail.com",
  "agent_id": "683f4657fcc016e56d66dbe8",
  "session_id": "683f4657fcc016e56d66dbe8-o6aq76s9a5",
  "message": "Hello, what are you upto?",
  "system_prompt_variables": {},
  "filter_variables": {},
  "features": [
    {
      "additionalProp1": {}
    }
  ]
}
'
import requests

url = "https://agent-prod.studio.lyzr.ai/v3/inference/chat/"

payload = {
    "user_id": "rohithchandra1952@gmail.com",
    "agent_id": "683f4657fcc016e56d66dbe8",
    "session_id": "683f4657fcc016e56d66dbe8-o6aq76s9a5",
    "message": "Hello, what are you upto?",
    "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: 'rohithchandra1952@gmail.com',
    agent_id: '683f4657fcc016e56d66dbe8',
    session_id: '683f4657fcc016e56d66dbe8-o6aq76s9a5',
    message: 'Hello, what are you upto?',
    system_prompt_variables: {},
    filter_variables: {},
    features: [{additionalProp1: {}}]
  })
};

fetch('https://agent-prod.studio.lyzr.ai/v3/inference/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://agent-prod.studio.lyzr.ai/v3/inference/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([
    'user_id' => 'rohithchandra1952@gmail.com',
    'agent_id' => '683f4657fcc016e56d66dbe8',
    'session_id' => '683f4657fcc016e56d66dbe8-o6aq76s9a5',
    'message' => 'Hello, what are you upto?',
    '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/chat/"

	payload := strings.NewReader("{\n  \"user_id\": \"rohithchandra1952@gmail.com\",\n  \"agent_id\": \"683f4657fcc016e56d66dbe8\",\n  \"session_id\": \"683f4657fcc016e56d66dbe8-o6aq76s9a5\",\n  \"message\": \"Hello, what are you upto?\",\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/chat/")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"user_id\": \"rohithchandra1952@gmail.com\",\n  \"agent_id\": \"683f4657fcc016e56d66dbe8\",\n  \"session_id\": \"683f4657fcc016e56d66dbe8-o6aq76s9a5\",\n  \"message\": \"Hello, what are you upto?\",\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/chat/")

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\": \"rohithchandra1952@gmail.com\",\n  \"agent_id\": \"683f4657fcc016e56d66dbe8\",\n  \"session_id\": \"683f4657fcc016e56d66dbe8-o6aq76s9a5\",\n  \"message\": \"Hello, what are you upto?\",\n  \"system_prompt_variables\": {},\n  \"filter_variables\": {},\n  \"features\": [\n    {\n      \"additionalProp1\": {}\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body
{
  "response": "Hello! How can I assist you today?"
}

Authorizations

x-api-key
string
header
required

Body

application/json
user_id
string
required
Example:

"rohithchandra1952@gmail.com"

agent_id
string
required
Example:

"683f4657fcc016e56d66dbe8"

session_id
string
required
Example:

"683f4657fcc016e56d66dbe8-o6aq76s9a5"

message
string
required
Example:

"Hello, what are you upto?"

system_prompt_variables
object

Optional dynamic variables to fill in the system prompt

Example:
{}
filter_variables
object

Optional filter values for prompt logic

Example:
{}
features
object[]

Optional features to modify behavior

Response

Successful agent response

response
string
Example:

"Hello! How can I assist you today?"