Skip to content
Voicebot

Get chat stream info

GET
/v1/adapters/llm/chat/stream/info/{id}
curl --request GET \
  --url https://example.com/v1/adapters/llm/chat/stream/info/example \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string

Chat stream id.

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
id
required
string
status
required
string
error
string
finish_reason
string
text
string
created
required
string
engine
required
string
commit
string
request
required
object
model
required
string
messages
required
Array<object>

A chat message. Content is a string; multimodal content is not supported.

object
role
required
string
content
required
string
name
string
function_call

A model-emitted function call (deprecated single-function form).

object
name
string
arguments

JSON-encoded argument string.

string
tool_calls
Array<object>
object
id
required
string
type
required
string
function
required

The function name and JSON-encoded arguments carried by a tool call.

object
name
string
arguments
string
tool_call_id
string
max_tokens
integer
temperature
number format: float
top_p
number format: float
n
integer
stream
boolean
stop
Array<string>
presence_penalty
number format: float
frequency_penalty
number format: float
logit_bias
object
key
additional properties
integer
logprobs
boolean
top_logprobs
integer
user
string
seed
integer
response_format
object
key
additional properties
any
tools
Array<object>
object
type
required
string
function
object
name
required
string
description
string
parameters
required

JSON-Schema parameter definition, kept deliberately loose.

object
key
additional properties
any
tool_choice

Tool-selection control: “none”/“auto”/“required” or an object.

functions
Array<object>
object
name
required
string
description
string
parameters
required

JSON-Schema parameter definition, kept deliberately loose.

object
key
additional properties
any
function_call

Function-selection control (deprecated): “none”/“auto” or an object.

parallel_tool_calls

Whether tool calls may run in parallel.

stream_options
object
key
additional properties
any
engine
string
Allowed values: open_ai azure
provider
string
backend
string
gdpr_required
boolean
metadata
object
call_sid
string
campaign_sid
string
scenario_sid
string
node_id
string
account_sid
string
target

Entity|intent|fallback|streaming

string
source

Hermes|bff|ss|ids

string
is_test
boolean
fallback_model
string
rag
object
document
object
ids
Array<string>
number
integer
threshold
number format: float
is_limit_with_documents
boolean
function_call

Deprecated: use tool_calls instead.

object
name
string
arguments

JSON-encoded argument string.

string
tool_calls
Array<object>
object
id
required
string
type
required
string
function
required

The function name and JSON-encoded arguments carried by a tool call.

object
name
string
arguments
string
usage
Array<object>
object
name
required
string
usage
object
prompt_tokens
required
integer
completion_tokens
required
integer
total_tokens
required
integer
tiktokens
required
integer
timeline
Array<object>
object
name
required
string
seconds
required
number format: float
details
Array<object>
object
name
required
string
detail
required

Arbitrary detail payload.

rag
object
document
object
ids
Array<string>
number
integer
threshold
number format: float
is_limit_with_documents
boolean
Example
{
  "request": {
    "engine": "open_ai"
  }
}

400

Section titled “400”

Invalid request body or parameters

Media typeapplication/json

Canonical structured error emitted by the chat completion, chat stream and embeddings handlers (the shared errorResponse helper). code is an application error code (0 when unset); status mirrors the HTTP status.

object
name
required
string
message
required
string
code
required
integer
status
required
integer
Examplegenerated
{
  "name": "example",
  "message": "example",
  "code": 1,
  "status": 1
}

401

Section titled “401”

Unauthorized

403

Section titled “403”

Forbidden

404

Section titled “404”

Resource does not exist

Media typeapplication/json

Canonical structured error emitted by the chat completion, chat stream and embeddings handlers (the shared errorResponse helper). code is an application error code (0 when unset); status mirrors the HTTP status.

object
name
required
string
message
required
string
code
required
integer
status
required
integer
Examplegenerated
{
  "name": "example",
  "message": "example",
  "code": 1,
  "status": 1
}

500

Section titled “500”

Internal server error

Media typeapplication/json

Canonical structured error emitted by the chat completion, chat stream and embeddings handlers (the shared errorResponse helper). code is an application error code (0 when unset); status mirrors the HTTP status.

object
name
required
string
message
required
string
code
required
integer
status
required
integer
Examplegenerated
{
  "name": "example",
  "message": "example",
  "code": 1,
  "status": 1
}

502

Section titled “502”

Bad gateway (upstream adapter error)