Skip to main content
POST
JavaScript

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

assistant_id
string
required

Unique identifier of the assistant.

Body

application/json
content
string
required

The message content sent by the client to the assistant

Example:

"Tell me a joke about cats"

conversation_id
string
required

A unique identifier for the conversation thread, used to maintain context

Example:

"42b20469-1215-4a9a-8964-c36f66b406f4"

name
string

The optional display name of the user sending the message

Example:

"Charlie"

stream
boolean
default:false

When true, the response is streamed as Server-Sent Events (text/event-stream): delta events carry content fragments as they are generated, a final done event carries the full content plus whatsapp_template, and a terminal error event reports failures that happen after streaming started. When false (default), the response is a single JSON object.

Response

Successful Response

content
string
required

The assistant's generated response based on the input message and context.

Example:

"Why did the cat sit on the computer? Because it wanted to keep an eye on the mouse!"