Skip to main content
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": {}
    }
  ]
}
'
{
  "response": "Streamed response will appear here"
}

Authorizations

​
x-api-key
string
header
required

Body

application/json
​
user_id
string
required
Example:

"default_user"

​
agent_id
string
required
Example:

"string"

​
session_id
string
required
Example:

"string"

​
message
string
required
Example:

"string"

​
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

Streaming started successfully

​
response
string
Example:

"Streamed response will appear here"