agents
Send Message Streaming
Process a user message and return the agent’s response. This endpoint accepts a message from a user and processes it through the agent. It will stream the steps of the response always, and stream the tokens if ‘stream_tokens’ is set to True.
POST
/
v1
/
agents
/
{agent_id}
/
messages
/
stream
Authorizations
Authorization
string
headerrequiredBearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
agent_id
string
requiredBody
application/json
messages
required
The messages to be sent to the agent.
assistant_message_tool_name
string
default: send_messageThe name of the designated message tool.
assistant_message_tool_kwarg
string
default: messageThe name of the message argument in the designated message tool.
stream_tokens
boolean
default: falseFlag to determine if individual tokens should be streamed. Set to True for token streaming (requires stream_steps = True).
Response
200 - text/event-stream
Server-Sent Events stream