Skip to main content
POST
Stream a Message to the Agent

Authorizations

x-auth-token
string
header
required

For server-to-server or automated access, use a DataGOL Service Account key. Pass it via the x-auth-token header instead of Authorization: x-auth-token: <service-account-key>

Body

application/json
agentType
enum<string>
required

Must be CustomAgent.

Available options:
CustomAgent
type
enum<string>
required

Duplicates agentType for internal routing.

Available options:
CustomAgent
conversationId
string<uuid>
required

The conversation ID returned by POST /ai/api/v2/conversations.

Example:

"ae5ee879-e967-45e4-bca0-c6c78d10bd23"

message
string
required

The user's message text to send to the agent.

Example:

"Summarise the data"

parameters
object
required
selectedLlmModel
string
required

Model for this specific message. Can be changed per message to switch models mid-conversation.

Example:

"gpt-5.2"

Response

200 - text/event-stream

Below is the mapping of each event type, its structure, and required frontend handling.