POST
/
chat
/
new-chat

Authorizations

Authorization
string
headerrequired

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json
brain_id
string
required

The ID of the brain to associate with the chat

name
string
required

The name of the chat

message
string
required

The initial message to start the chat

response_length
enum<string> | null
default: MEDIUM

Configure response length

Available options:
SHORT,
MEDIUM,
LONG
temperature
number | null

between 0 and 1

Required range: 0 < x < 1
system_message
string | null

System message for the LLM

model
string | null
default: gpt-4o-mini

LLM Model to choose from

chat_message_type
enum<string>
default: TEXT
Available options:
JSON,
TEXT

Response

200 - application/json
actor
string

The actor (USER or AI) of the interaction

created_at
string

The timestamp when the interaction was created

dw_data
object | null

The data related to the data warehouse integration

id
integer

The unique identifier of the interaction

message
string

The message content of the interaction

metadata
object | null

The metadata associated with the interaction

model
string | null

The name of the model used for the interaction

reference
object[] | null

The list of references associated with the interaction

thread_id
string

The ID of the chat thread associated with the interaction

timestamp
string

The timestamp when the interaction occurred

user_credits
integer | null

The number of credits used by the user for the interaction