Skip to main content
POST
Chat

Headers

Authorization
string
required

Body

application/json
thread_id
string
required

The unique identifier for the thread you're sending a message in.

message
string
required

The message sent by the user.

puppeteer_config_name
string
required

The name of the Puppeteer project this thread belongs to.

streaming
boolean | null
default:false

Whether to stream the response back with HTTP streaming.

config_version_id
string | null
start_new_conversation
boolean | null
default:false

Whether this message is the first in a new conversation inside the thread.

simulate
SimulatedMessage · object | null
user_type
string | null

Response

Successful Response

message
string
required

The AI's response to the message.

extras
ChatExtras · object
required

Metadata about the created messages and conversation.