agentsMessages

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.

Path parameters

agent_idstringRequired

Headers

AuthorizationstringRequired

Header authentication of the form Bearer <token>

Request

This endpoint expects an object.
messageslist of objectsRequired
The messages to be sent to the agent.
max_stepsintegerOptionalDefaults to 50
Maximum number of steps the agent should take to process the request.
use_assistant_messagebooleanOptionalDefaults to true

Whether the server should parse specific tool call arguments (default send_message) as AssistantMessage objects.

assistant_message_tool_namestringOptionalDefaults to send_message
The name of the designated message tool.
assistant_message_tool_kwargstringOptionalDefaults to message
The name of the message argument in the designated message tool.
include_return_message_typeslist of enums or nullOptional

Only return specified message types in the response. If None (default) returns all messages.

enable_thinkingstringOptional
If set to True, enables reasoning before responses or tool calls from the agent.
stream_tokensbooleanOptionalDefaults to false
Flag to determine if individual tokens should be streamed, rather than streaming per step.
include_pingsbooleanOptionalDefaults to true
Whether to include periodic keepalive ping messages in the stream to prevent connection timeouts.
backgroundbooleanOptionalDefaults to false
Whether to process the request in the background.

Response

Successful response

Errors